Order Property of the IFPCLdapServer Interface

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.

[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 LDAP server in the list of LDAP servers.

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 LDAP server in the list of LDAP servers.

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

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCLdapServer


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.

[an error occurred while processing this directive]