UserAgent Property of the IFPCUserAgentMapping Interface

Article
08/13/2010

The UserAgent property gets or sets a string that specifies the User-Agent headers.

C++

HRESULT put_UserAgent(
    BSTR bstrUserAgent
);
HRESULT get_UserAgent(
    BSTR* pbstrUserAgent
);

Parameters

bstrUserAgent
BSTR that specifies the User-Agent headers.
pbstrUserAgent
Pointer to a BSTR that is set on return to a string value specifying the User-Agent headers.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Visual Basic

Property UserAgent As String

Property Value

String that specifies the User-Agent headers.

Remarks

This property is read/write. The value of this property is initially set when the object is created using the Add method of the FPCUserAgentMappings collection (IFPCUserAgentMappings interface in C++).

The string specified in this property may contain wildcard characters (*). A User-Agent mapping whose UserAgent property is set to a wildcard character (*) applies to all User-Agent headers. A User-Agent mapping whose UserAgent property is set to a string that begins and ends with a wildcard character applies to any User-Agent header that contains the substring between the wildcard characters.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.

Share via