Share via


ObtainUserAgentString

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the user agent string in use.

Syntax

HRESULT ObtainUserAgentString(
  DWORD dwOption,
  LPCSTR pcszUAOut,
  DWORD* cbSize
);

Parameters

  • dwOption
    Reserved. Must be set to zero.
  • pcszUAOut
    Address of a string value that contains the user agent string currently being used.
  • cbSize
    Address of an unsigned long integer value that contains the length of the string.

Return Value

This function returns one of the values shown in the following table.

Value Description

E_INVALIDARG

One of the parameters is invalid.

E_OUTOFMEMORY

The operation ran out of memory.

NOERROR

The function completed successfully.

Requirements

Header urlmon.h, urlmon.idl
Library urlmon.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later