IFPCLdapServer::Order property

Article
08/27/2012

Applies to: desktop apps only

The Order property gets the ordinal position of the LDAP server in the LDAP servers set, which corresponds to the order in which the LDAP servers handle an authentication request. If the first server in the list is unavailable, the request is forwarded to the second server, and so on.

This property is read-only.

Syntax

HRESULT get_Order(
  long *plOrder
);

' Data type: Long

Property Order( _
  ByVal plOrder As long _
) As Long

Property value

A 32-bit integer that specifies the ordinal position of the LDAP server in the list of LDAP servers.

Error codes

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

Remarks

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

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