Order Property of the IFPCUserAgentMapping Interface

Article
08/13/2010

The Order property gets the ordinal position of the User-Agent mapping in the list of User-Agent mappings, which corresponds to the order in which the User-Agent mappings are tested to find a mapping that matches the User-Agent header in a request. If the first mapping in the list does not match the User-Agent header in a request, the second mapping is tested, and so on.

C++

HRESULT get_Order(
    long* plOrder
);

Parameters

plOrder
Pointer to a variable that on return receives a 32-bit integer specifying the ordinal position of the User-Agent mapping in the list of User-Agent mappings.

Return Value

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

Visual Basic

Property Order As Long

Property Value

A 32-bit integer that specifies the ordinal position of the User-Agent mapping in the list of User-Agent mappings.

Remarks

This property is read-only. It corresponds to the one-based index of the object in the FPCUserAgentMappings collection, and can be modified by calling the MoveUp and MoveDown methods of the FPCUserAgentMappings collection. Because these methods change the ordinal positions of more than one User-Agent mapping in the collection, the Save method must be called on the collection to write the changes to persistent storage.

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