Option Flags

Contents  Index  Topic Contents

Previous Topic: HTTP Status Codes
Next Topic: Error Messages

Option Flags

The following list contains the options supported by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_ASYNC

Not currently implemented.

INTERNET_OPTION_ASYNC_PRIORITY

Not currently implemented.

INTERNET_OPTION_CACHE_STREAM_HANDLE

No longer supported.

INTERNET_OPTION_CALLBACK

Returns or sets the address of the callback function defined for this handle. This option can be used on all HINTERNET handles. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_CALLBACK_FILTER

Not currently implemented

INTERNET_OPTION_CONNECT_BACKOFF

Not currently implemented.

INTERNET_OPTION_CONNECT_LIMIT

Not currently implemented.

INTERNET_OPTION_CONNECT_RETRIES

Returns or sets the retry count to use for Internet connection requests. If a connection attempt still fails after the specified number of tries, the request is canceled. The default is five retries. This option can be used on any HINTERNET handle, including a NULL handle. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_CONNECT_TIME

Not currently implemented.

INTERNET_OPTION_CONNECT_TIMEOUT

Returns or sets the time-out value, in milliseconds, to use for Internet connection requests. If a connection request takes longer than this time-out value, the request is canceled. This option can be used on any HINTERNET handle, including a NULL handle. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_CONNECTED_STATE

Returns or sets the connected state. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_CONTEXT_VALUE

Returns or sets the context value associated with this Internet handle. This option can be used on any HINTERNET handle. Used by InternetQueryOption and InternetSetOption. Previously, this set the context value to the address stored in the DWORD(lpBuffer) pointer. This has been corrected so that the value stored in the buffer will be used and the INTERNET_OPTION_CONTEXT_VALUE flag will be reassigned a new value. The old value, 10, has been preserved so that applications written for the old behavior are still supported.

INTERNET_OPTION_CONTROL_RECEIVE_TIMEOUT

Identical to INTERNET_OPTION_RECEIVE_TIMEOUT. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_CONTROL_SEND_TIMEOUT

Identical to INTERNET_OPTION_SEND_TIMEOUT. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_DATA_RECEIVE_TIMEOUT

Returns or sets the time-out value, in milliseconds, to use for Internet data download requests. If a data receive request takes longer than this time-out value, the request is canceled. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_DATA_SEND_TIMEOUT

Returns or sets the time-out value, in milliseconds, to use for Internet data send requests. If a data send request takes longer than this time-out value, the request is canceled. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_DATAFILE_NAME

Returns the name of the file backing a downloaded entity. This flag is valid after InternetOpenUrl, FtpOpenFile, GopherOpenFile, or HttpOpenRequest has completed. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_DISCONNECTED_TIMEOUT

Not currently implemented.

INTERNET_OPTION_END_BROWSER_SESSION

Flushes entries not in use from the password cache on the hard drive. Also resets the cache time used when the synchronization mode is once-per-session. Used by InternetSetOption.

INTERNET_OPTION_ERROR_MASK

Not currently implemented.

INTERNET_OPTION_EXTENDED_ERROR

Returns the Windows Sockets error message that was mapped to the ERROR_INTERNET_ error messages last returned in this thread context. This option is used on a NULL HINTERNET handle by InternetQueryOption.

INTERNET_OPTION_HANDLE_TYPE

Returns the type of the Internet handle passed in. Used by InternetQueryOption on any HINTERNET handle. Possible return values include:

INTERNET_HANDLE_TYPE_CONNECT_FTP
INTERNET_HANDLE_TYPE_CONNECT_GOPHER
INTERNET_HANDLE_TYPE_CONNECT_HTTP
INTERNET_HANDLE_TYPE_FTP_FILE
INTERNET_HANDLE_TYPE_FTP_FILE_HTML
INTERNET_HANDLE_TYPE_FTP_FIND
INTERNET_HANDLE_TYPE_FTP_FIND_HTML
INTERNET_HANDLE_TYPE_GOPHER_FILE
INTERNET_HANDLE_TYPE_GOPHER_FILE_HTML
INTERNET_HANDLE_TYPE_GOPHER_FIND
INTERNET_HANDLE_TYPE_GOPHER_FIND_HTML
INTERNET_HANDLE_TYPE_HTTP_REQUEST
INTERNET_HANDLE_TYPE_INTERNET

INTERNET_OPTION_HTTP_VERSION

Returns or sets the HTTP version being supported. Must be used on a NULL handle. An HTTP_VERSION_INFO structure is used to set or get the version information. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_IDLE_STATE

Not currently implemented.

INTERNET_OPTION_KEEP_CONNECTION

Not currently implemented.

INTERNET_OPTION_LISTEN_TIMEOUT

Not currently implemented.

INTERNET_OPTION_OFFLINE_MODE

Not currently implemented.

INTERNET_OPTION_OFFLINE_SEMANTICS

Not currently implemented.

INTERNET_OPTION_PARENT_HANDLE

Returns the parent handle to this handle. This option can be used on any HINTERNET handle by InternetQueryOption.

INTERNET_OPTION_PASSWORD

Returns or sets the password associated with a handle returned by InternetConnect. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_POLICY

Not currently implemented.

INTERNET_OPTION_PROXY

Returns or sets the proxy information on an existing InternetOpen handle when the HINTERNET handle is not NULL. If the HINTERNET handle is NULL, the function sets or queries the global proxy information. The lpBuffer parameter is an INTERNET_PROXY_INFO structure that contains the proxy information. This option can be used on the HINTERNET handle returned by InternetOpen. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_PROXY_PASSWORD

Returns or sets the password currently being used to access the proxy. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_PROXY_USERNAME

Returns or sets the user name currently being used to access the proxy. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_READ_BUFFER_SIZE

Returns or sets the size of the read buffer. This option can be used on HINTERNET handles returned by FtpOpenFile, FtpFindFirstFile, and InternetConnect (FTP session only). Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_RECEIVE_THROUGHPUT

Not currently implemented.

INTERNET_OPTION_RECEIVE_TIMEOUT

Returns or sets the time-out value, in milliseconds, to receive a response to a request. If the response takes longer than this time-out value, the request is canceled. This option can be used on any HINTERNET handle, including a NULL handle. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_REFRESH

Returns or sets the value that determines if the proxy information can be reread from the registry for a handle. The value TRUE indicates that the proxy information can be reread from the registry for a handle. This option can be used on the HINTERNET handle returned by InternetOpen. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_REQUEST_FLAGS

Returns special status flags about the current download in progress. Used by InternetQueryOption. The flag can be one of the following values:

INTERNET_REQFLAG_ASYNC Not currently implemented.

INTERNET_REQFLAG_FROM_CACHE Response came from the cache.

INTERNET_REQFLAG_NO_HEADERS Original response contained no headers.

INTERNET_REQFLAG_PASSIVE Not currently implemented.

INTERNET_REQFLAG_VIA_PROXY Request was made through a proxy.

INTERNET_OPTION_REQUEST_PRIORITY

Returns or sets the priority of requests competing for a connection on an HTTP handle. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_SECONDARY_CACHE_KEY

Returns or sets the secondary cache key. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_SECURITY_CERTIFICATE

Returns the certificate for an SSL/PCT (Secure Sockets Layer/Private Communications Technology) server into a formatted string. Used by InternetQueryOption.

INTERNET_OPTION_SECURITY_CERTIFICATE_STRUCT

Returns the certificate for an SSL/PCT server into the INTERNET_CERTIFICATE_INFO structure. Used by InternetQueryOption.

INTERNET_OPTION_SECURITY_FLAGS

Returns the security flags for a handle. Used by InternetQueryOption. Can be a combination of these values:

SECURITY_FLAG_128BIT: Identical to the preferred value SECURITY_FLAG_STRENGTH_STRONG. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_40BIT: Identical to the preferred value SECURITY_FLAG_STRENGTH_WEAK. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_56BIT: Identical to the preferred value SECURITY_FLAG_STRENGTH_MEDIUM. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_IETFSSL4: Not currently implemented.
SECURITY_FLAG_IGNORE_CERT_CN_INVALID: Ignores the ERROR_INTERNET_SEC_CERT_CN_INVALID error message.
SECURITY_FLAG_IGNORE_CERT_DATE_INVALID: Ignores the ERROR_INTERNET_SEC_CERT_DATE_INVALID error message.
SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTP: Ignores the ERROR_INTERNET_HTTPS_TO_HTTP_ON_REDIR error message.
SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTPS: Ignores the ERROR_INTERNET_HTTP_TO_HTTPS_ON_REDIR error message.
SECURITY_FLAG_IGNORE_REVOCATION: Ignores certificate revocation problems.
SECURITY_FLAG_IGNORE_UNKNOWN_CA: Ignore unknown certificate authority problems.
SECURITY_FLAG_IGNORE_WRONG_USAGE: Ignore incorrect usage problems.
SECURITY_FLAG_NORMALBITNESS: Identical to the value SECURITY_FLAG_STRENGTH_WEAK. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_PCT: Not currently implemented.
SECURITY_FLAG_PCT4: Not currently implemented.
SECURITY_FLAG_SECURE: Uses secure transfers. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_SSL: Not currently implemented.
SECURITY_FLAG_SSL3: Not currently implemented.
SECURITY_FLAG_STRENGTH_MEDIUM: Uses medium (56 bit) encryption. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_STRENGTH_STRONG: Uses strong (128 bit) encryption. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_STRENGTH_WEAK: Uses weak (40 bit) encryption. Only returned in a call to InternetQueryOption.
SECURITY_FLAG_UNKNOWNBIT: The bit size used in the encryption is unknown. Only returned in a call to InternetQueryOption.

INTERNET_OPTION_SECURITY_KEY_BITNESS

Returns the bit size of the encryption key. The larger the number, the greater the encryption strength being used. Used by InternetQueryOption.

INTERNET_OPTION_SECURITY_SELECT_CLIENT_CERT

Sets the client certification. Used by InternetSetOption.

INTERNET_OPTION_SEND_THROUGHPUT

Not currently implemented.

INTERNET_OPTION_SEND_TIMEOUT

Returns or sets the time-out value, in milliseconds, to send a request. If the send takes longer than this time-out value, the send is canceled. This option can be used on any HINTERNET handle, including a NULL handle. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_SETTINGS_CHANGED

Informs WinInet that the registry settings have been changed, so that it will check the settings on the next call to InternetConnect. Used by InternetSetOption.

INTERNET_OPTION_URL

Returns the full URL of a downloaded resource. If the original URL contained any extra information (such as search strings or anchors) or if the call was redirected, the URL returned will differ from the original. This option is valid on HINTERNET handles returned by InternetOpenUrl, FtpOpenFile, GopherOpenFile, or HttpOpenRequest. Used by InternetQueryOption.

INTERNET_OPTION_USER_AGENT

Returns or sets the user agent string on handles supplied by InternetOpen and used in subsequent HttpSendRequest functions, as long as it is not overridden by a header added by HttpAddRequestHeaders or HttpSendRequest. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_USERNAME

Returns or sets the user name associated with a handle returned by InternetConnect. Used by InternetQueryOption and InternetSetOption.

INTERNET_OPTION_VERSION

Returns the version number of Wininet.dll. The lpBuffer parameter is the address of an INTERNET_VERSION_INFO structure. This option can be used on a NULL HINTERNET handle. Used by InternetQueryOption.

INTERNET_OPTION_WRITE_BUFFER_SIZE

Returns or sets the size of the write buffer. This option can be used on HINTERNET handles returned by FtpOpenFile and InternetConnect (FTP session only). Used by InternetQueryOption and InternetSetOption.


		Contents Index Topic Contents
	Previous Topic: HTTP Status Codes Next Topic: Error Messages

INTERNET_REQFLAG_ASYNC	Not currently implemented.
INTERNET_REQFLAG_FROM_CACHE	Response came from the cache.
INTERNET_REQFLAG_NO_HEADERS	Original response contained no headers.
INTERNET_REQFLAG_PASSIVE	Not currently implemented.
INTERNET_REQFLAG_VIA_PROXY	Request was made through a proxy.