ldap_parse_sort_control function (winldap.h)

Article
02/22/2024

The ldap_parse_sort_control function parses the sort control returned by the server.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_parse_sort_control(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPControlA *Control,
  [out] ULONG         *Result,
  [out] PCHAR         *Attribute
);

Parameters

[in] ExternalHandle

The session handle.

[in] Control

The control returned from the server, as obtained from a call to ldap_parse_result.

[out] Result

The result code.

[out] Attribute

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

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	winldap.h
Library	Wldap32.lib
DLL	Wldap32.dll