IFPCUserAgentMapping::UserAgent property

Article
08/27/2012

Applies to: desktop apps only

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

This property is read/write.

Syntax

HRESULT put_UserAgent(
  BSTR bstrUserAgent
);

HRESULT get_UserAgent(
  BSTR *pbstrUserAgent
);

' Data type: String

Property UserAgent( _
  ByVal bstrUserAgent As BSTR, _
  ByVal pbstrUserAgent As BSTR _
) As String

Property value

String that specifies the User-Agent headers.

Error codes

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

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

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll