UserAgentMappings Property of the IFPCRuleElements2 Interface

The UserAgentMappings property gets an FPCUserAgentMappings collection that contains an ordered set of all the mappings between User-Agent headers and the type of forms for forms-based authentication defined in the array.

C++

HRESULT get_UserAgentMappings(
    IFPCUserAgentMappings** ppUserAgentMappings
);

Parameters

  • ppUserAgentMappings
    Address of an interface pointer that on return points to an IFPCUserAgentMappings interface that represents the collection of all the mappings between User-Agent headers and the type of forms for forms-based authentication defined in the array.

Return Value

This property method returns S_OK if the call is successful; otherwise, it returns an error code.

Visual Basic

Property UserAgentMappings As FPCUserAgentMappings

Property Value

Reference to an FPCUserAgentMappings collection that contains an ordered set of all the mappings between User-Agent headers and the type of forms for forms-based authentication defined in the array.

Remarks

This property is read-only. Mappings between User-Agent headers and the type of forms to be used for forms-based authentication can be added and removed by calling the Add and Remove methods of the FPCUserAgentMappings collection retrieved (the IFPCUserAgentMappings interface retrieved in C++).

This property is not supported for the FPCRuleElements object (IFPCRuleElements interface in C++) accessed through the RuleElements property of the FPCEnterprise object (IFPCEnterprise interface in C++) (available only in Forefront TMG Enterprise Edition).

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.

See Also

FPCRuleElements

Send comments about this topic to Microsoft

Build date: 6/30/2010