Função ldap_get_next_page_s (winldap.h)
A função ldap_get_next_page_s retorna a próxima página em uma sequência de resultados de pesquisa paginado síncronos.
Sintaxe
WINLDAPAPI ULONG LDAPAPI ldap_get_next_page_s(
[in] PLDAP ExternalHandle,
[in] PLDAPSearch SearchHandle,
[in] l_timeval *timeout,
[in] ULONG PageSize,
[out] ULONG *TotalCount,
[out] LDAPMessage **Results
);
Parâmetros
[in] ExternalHandle
Identificador de sessão.
[in] SearchHandle
Identificador de bloco de pesquisa.
[in] timeout
O valor de tempo, em segundos, que o cliente aguardará o retorno da chamada.
[in] PageSize
O número de entradas a serem retornadas em uma única página.
[out] TotalCount
A estimativa do servidor do número total de entradas em todo o conjunto de resultados. Um valor zero indica que o servidor não pode fornecer uma estimativa.
[out] Results
Um ponteiro para a estrutura LDAPMessage que contém os resultados.
Retornar valor
Se o servidor retornar um cookie nulo (não continuação), o valor será LDAP_NO_RESULTS_RETURNED. Caso contrário, o cliente sinaliza uma continuação (mais dados disponíveis) retornando LDAP_SUCCESS.
Se a função falhar de outra forma, ela retornará o valor retornado do código de erro relacionado à falha. Para obter mais informações, consulte Valores retornados.
Comentários
A função ldap_get_next_page_s faz parte da interface para paginação simples e síncrona dos resultados da pesquisa. Use o identificador de pesquisa retornado de uma chamada inicial para ldap_search_init_page e especifique, no parâmetro PageSize , o número de entradas a serem retornadas em uma página. Defina PageSize como zero para encerrar uma pesquisa.
Os resultados retornados de ldap_get_next_page_s podem ser tratados como qualquer outro resultado de pesquisa e devem ser liberados, quando concluídos, chamando ldap_msgfree.
Ao analisar o conjunto de resultados, é possível que o servidor retorne uma página vazia de resultados e ainda responda com um código de retorno LDAP_SUCCESS . Isso indica que o servidor não pôde recuperar uma página de resultados devido a um tempo limite ou outro motivo, mas não concluiu a solicitação de pesquisa. O comportamento adequado nesta instância é continuar a chamar ldap_get_next_page_s até que outra página de resultados seja recuperada com êxito, um código de erro seja retornado ou LDAP_NO_RESULTS_RETURNED seja retornado para indicar que a pesquisa está concluída.
Para recuperar o resultado da pesquisa paginada de forma assíncrona, use ldap_get_next_page.
Se ldap_get_next_page_s for usado, não será necessário que ldap_get_paged_count seja chamado para registrar o número de resultados paginado retornados por um servidor.
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 |