Compartilhar via


Função ldap_create_sort_control (winldap.h)

A função ldap_create_sort_control é usada para formatar uma lista de chaves de classificação em um controle de pesquisa. O suporte para controles está disponível em vigor com o LDAP 3, mas se o controle de classificação tem suporte ou não depende do servidor específico.

Sintaxe

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

Parâmetros

[in] ExternalHandle

O identificador da sessão.

[in] SortKeys

Ponteiro para uma matriz de estruturas LDAPSortKey . Cada estrutura na matriz especifica o nome de um atributo a ser usado como uma chave de classificação, a regra de correspondência para essa chave e se a ordem de classificação é crescente ou decrescente.

[in] IsCritical

Notifica o servidor se esse controle é crítico para a pesquisa. 0 ==> FALSE, !0 ==> TRUE.

[out] Control

Ponteiro para o controle recém-criado.

Retornar valor

Essa função retorna WINLDAPAPI ULONG LDAPAPI.

Comentários

A função ldap_create_sort_control cria um controle de classificação básico. Esse controle é útil quando o cliente LDAP tem funcionalidade limitada e não pode classificar os resultados, mas precisa deles classificados.

Os controles de classificação permitem que um servidor retorne um código de resultado para a classificação dos resultados que são independentes do código de resultado retornado para a operação de pesquisa.

Essa função cria o controle – não verifica se o servidor dá suporte a ele e, consequentemente, não retorna LDAP_UNAVAILABLE_CRIT_EXTENSION se o servidor não dá suporte ao controle. No entanto, ele pode retornar outros valores de retorno LDAP padrão, como LDAP_NO_MEMORY ou LDAP_PARAM_ERROR.

Para liberar o controle quando ele não for mais necessário, chame ldap_control_free.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista
Servidor mínimo com suporte Windows Server 2008
Plataforma de Destino Windows
Cabeçalho winldap.h
Biblioteca Wldap32.lib
DLL Wldap32.dll

Confira também

Funções

LDAPSortKey

LDAP_SERVER_SORT_OID

ldap_control_free