ldap_parse_sort_control function
The ldap_parse_sort_control function parses the sort control returned by the server.
Syntax
ULONG ldap_parse_sort_control( _In_ PLDAP ExternalHandle, _In_ PLDAPControl *Control, _Out_ ULONG *Result, _Out_ PCHAR *Attribute );
Parameters
- ExternalHandle [in]
-
The session handle.
- Control [in]
-
The control returned from the server, as obtained from a call to ldap_parse_result.
- Result [out]
-
The result code.
- Attribute [out]
-
A pointer to a null-terminated string that contains the name of the attribute that caused the operation to fail.
Return value
If the function succeeds, the return value is LDAP_SUCCESS.
If the function fails, it returns an error code. See Return Values for more information.
Remarks
When the server returns the results, it returns a control in the SearchResultDone message. Call ldap_parse_sort_control to parse this sort control.
If the sort operation failed, the server may return the name of the attribute that caused the failure. In this case, call ldap_memfree to free the attribute value
Requirements
|
Minimum supported client |
Windows Vista |
|---|---|
|
Minimum supported server |
Windows Server 2008 |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
ldap_parse_sort_controlW (Unicode) and ldap_parse_sort_controlA (ANSI) |
See also