UrlMkSetSessionOption

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function sets options for the current Internet session.

Syntax

HRESULT UrlMkSetSessionOption(
  DWORD dwOption,
  LPVOID pBuffer,
  DWORD dwBufferLength,
  DWORD dwReserved
);

Parameters

• dwOption
  [in] Unsigned long integer value that contains the option to be set. This can be one of the values shown in the following table.

  Value	Description
  INTERNET_OPTION_PROXY	Sets the proxy settings. The pBuffer parameter must contain an INTERNET_PROXY_INFO structure. INTERNET_OPTION_PROXY and INTERNET_PROXY_INFO are defined in the Wininet.h file. For more information, see the WinInet API.
  INTERNET_OPTION_REFRESH	Sets the value that determines if the proxy information can be reread from the registry. The value TRUE indicates that the proxy information can be reread from the registry. For more information, see the WinInet API.
  URLMON_OPTION_USERAGENT	Sets the user agent string for this process.
  URLMON_OPTION_USERAGENT_REFRESH	Refreshes the user agent string from the registry for this process.

• pBuffer
  [in] Address of the buffer containing the new session settings.

• dwBufferLength
  [in] Unsigned long integer value that contains the size of pBuffer.

• dwReserved
  [in] Reserved. Must be set to zero.

Return Value

Returns S_OK if options were successfully set or E_INVALIDARG if one of the parameters is invalid.

Remarks

This function maps directly to the Windows Internet function InternetSetOption, although UrlMkSetSessionOption allows only global options to be set.

To use this function, the client code must include the Wininet.h file, which declares values for the dwOption parameter and structures for the pBuffer parameter.

Requirements