InternetQueryOption function

Queries an Internet option on the specified handle.

Syntax


BOOL InternetQueryOption(
  _In_    HINTERNET hInternet,
  _In_    DWORD     dwOption,
  _Out_   LPVOID    lpBuffer,
  _Inout_ LPDWORD   lpdwBufferLength
);

Parameters

hInternet [in]: Handle on which to query information.
dwOption [in]: Internet option to be queried. This can be one of the Option Flags values.
lpBuffer [out]: Pointer to a buffer that receives the option setting. Strings returned by InternetQueryOption are globally allocated, so the calling application must free them when it is finished using them.
lpdwBufferLength [in, out]: Pointer to a variable that contains the size of lpBuffer, in bytes. When InternetQueryOption returns, lpdwBufferLength specifies the size of the data placed into lpBuffer. If GetLastError returns ERROR_INSUFFICIENT_BUFFER, this parameter points to the number of bytes required to hold the requested information.

Return value

Returns TRUE if successful, or FALSE otherwise. To get a specific error message, call GetLastError.

Remarks

GetLastError will return the ERROR_INVALID_PARAMETER if an option flag that is invalid for the specified handle type is passed to the dwOption parameter.

For more information, see Setting and Retrieving Internet Options.

Like all other aspects of the WinINet API, this function cannot be safely called from within DllMain or the constructors and destructors of global objects.

Note WinINet does not support server implementations. In addition, it should not be used from a service. For server implementations or services use Microsoft Windows HTTP Services (WinHTTP).

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Wininet.h
Library	Wininet.lib
DLL	Wininet.dll
Unicode and ANSI names	InternetQueryOptionW (Unicode) and InternetQueryOptionA (ANSI)