ldap_encode_sort_control function

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

C++
Copy 

ULONG ldap_encode_sort_control(
  _In_  PLDAP        ExternalHandle,
  _In_  PLDAPSortKey *SortKeys,
  _Out_ PLDAPControl Control,
  _In_  BOOLEAN      IsCritical
);

Parameters

ExternalHandle [in]

The session handle.

SortKeys [in]

A list of LDAPSortKey structures.

Control [out]

Pointer to the new control.

IsCritical [in]

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

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header
Winldap.h

Library
Wldap32.lib

DLL
Wldap32.dll

Unicode and ANSI names

ldap_encode_sort_controlW (Unicode) and ldap_encode_sort_controlA (ANSI)

See also

Functions
ldap_create_sort_control
LDAPSortKey

 

 

Show: