Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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