Share via


función ldap_create_sort_control (winldap.h)

La función ldap_create_sort_control se usa para dar formato a una lista de claves de ordenación en un control de búsqueda. La compatibilidad con los controles está disponible en vigor con LDAP 3, pero si el control de ordenación es compatible o no depende del servidor determinado.

Sintaxis

WINLDAPAPI ULONG LDAPAPI ldap_create_sort_control(
  [in]  PLDAP         ExternalHandle,
  [in]  PLDAPSortKeyA *SortKeys,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlA *Control
);

Parámetros

[in] ExternalHandle

Identificador de sesión.

[in] SortKeys

Puntero a una matriz de estructuras LDAPSortKey . Cada estructura de la matriz especifica el nombre de un atributo que se va a usar como clave de ordenación, la regla de coincidencia para esa clave y si el criterio de ordenación es ascendente o descendente.

[in] IsCritical

Notifica al servidor si este control es crítico para la búsqueda. 0 ==> FALSE, !0 ==> TRUE.

[out] Control

Puntero al control recién creado.

Valor devuelto

Esta función devuelve LDAPAPI de WINLDAPAPI ULONG.

Comentarios

La función ldap_create_sort_control crea un control de ordenación básico. Este control es útil cuando el cliente LDAP tiene una funcionalidad limitada y no puede ordenar los resultados, pero los necesita ordenados.

Los controles de ordenación permiten a un servidor devolver un código de resultado para la ordenación de los resultados que es independiente del código de resultado devuelto para la operación de búsqueda.

Esta función crea el control , no comprueba que el servidor lo admita y, por lo tanto, no devuelve LDAP_UNAVAILABLE_CRIT_EXTENSION si el servidor no admite el control. Sin embargo, puede devolver otros valores devueltos LDAP estándar, como LDAP_NO_MEMORY o LDAP_PARAM_ERROR.

Para liberar el control cuando ya no sea necesario, llame a ldap_control_free.

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista
Servidor mínimo compatible Windows Server 2008
Plataforma de destino Windows
Encabezado winldap.h
Library Wldap32.lib
Archivo DLL Wldap32.dll

Vea también

Funciones

LDAPSortKey

LDAP_SERVER_SORT_OID

ldap_control_free