Edit

ldap_encode_sort_control function (winldap.h)

  • Article

The ldap_encode_sort_control function formats a list of sort keys into a search control. This function is obsolete. Instead, use ldap_create_sort_control.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_encode_sort_control(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPSortKeyA *SortKeys,
  [out] PLDAPControlA Control,
  [in]  BOOLEAN       Criticality
);

Parameters

[in] ExternalHandle

The session handle.

[in] SortKeys

A list of LDAPSortKey structures.

[out] Control

Pointer to the new control.

[in] Criticality

Notifies the server whether this control is critical to the search.

Return value

If the call completed successfully, LDAP_SUCCESS is returned. Other standard LDAP return values, such as LDAP_NO_MEMORY or LDAP_PARAM_ERROR, may also be returned.

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

See also

Functions

LDAPSortKey

ldap_create_sort_control