Compartilhar via


função ldap_create_page_control (winldap.h)

Use a função ldap_create_page_control para criar um controle básico para resultados de paginação. O suporte para controles está disponível em vigor com o LDAP 3, mas se o controle de página tem suporte ou não depende do servidor específico.

Sintaxe

WINLDAPAPI ULONG LDAPAPI ldap_create_page_control(
  [in]  PLDAP         ExternalHandle,
  [in]  ULONG         PageSize,
  [in]  berval        *Cookie,
  [in]  UCHAR         IsCritical,
  [out] PLDAPControlA *Control
);

Parâmetros

[in] ExternalHandle

O identificador de sessão.

[in] PageSize

O número de entradas a serem retornadas em cada página.

[in] Cookie

Ponteiro para uma estrutura berval que o servidor usa para determinar sua localização no conjunto de resultados. Essa é uma estrutura opaca que você não deve acessar diretamente. Defina como NULL para a primeira chamada para ldap_create_page_control.

[in] IsCritical

Notifica o servidor se esse controle é crítico para a pesquisa.

[out] Control

Ponteiro para o controle recém-criado.

Valor retornado

Essa função retorna WINLDAPAPI ULONG LDAPAPI.

Comentários

A função ldap_create_page_control cria um controle de resultados paginado simples. O controle permite que o cliente especifique a taxa na qual um servidor LDAP retorna os resultados de uma operação de pesquisa. Isso é útil quando o cliente tem recursos limitados e pode não ser capaz de processar todo o conjunto de resultados de uma determinada consulta LDAP ou quando a conexão cliente/servidor está lenta.

Para criar o controle paged-results, especifique o número de entradas a serem retornadas em uma única página. Para retornar resultados normalmente, mesmo que não possa dar suporte a esse controle, defina o parâmetro IsCritical como FALSE.

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.

Quando ldap_create_page_control retorna com êxito, inclua o controle recém-criado na lista de controles de servidor em uma chamada para ldap_search_ext ou para ldap_search_ext_s. Quando o servidor retornar a primeira página de resultados, chame ldap_parse_result para recuperar a primeira página de resultados.

Chame ldap_control_free quando o controle não for mais necessário.

Requisitos

   
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

LDAP_PAGED_RESULT_OID_STRING

ldap_control_free

ldap_parse_page_control

ldap_parse_result

ldap_search_ext

ldap_search_ext_s