Función ldap_get_next_page_s (winldap.h)
La función ldap_get_next_page_s devuelve la página siguiente en una secuencia de resultados de búsqueda paginados sincrónicos.
Sintaxis
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 sesión.
[in] SearchHandle
Identificador de bloque de búsqueda.
[in] timeout
Valor de tiempo, en segundos, que el cliente esperará a que se devuelva la llamada.
[in] PageSize
Número de entradas que se van a devolver en una sola página.
[out] TotalCount
Estimación del servidor del número total de entradas en todo el conjunto de resultados. Un valor de cero indica que el servidor no puede proporcionar una estimación.
[out] Results
Puntero a la estructura LDAPMessage que contiene los resultados.
Valor devuelto
Si el servidor devuelve una cookie nula (no continuación), el valor es LDAP_NO_RESULTS_RETURNED. De lo contrario, el cliente señala una continuación (más datos disponibles) devolviendo LDAP_SUCCESS.
Si se produce un error en la función, devuelve el valor devuelto del código de error relacionado con el error. Para obtener más información, vea Valores devueltos.
Comentarios
La función ldap_get_next_page_s forma parte de la interfaz para la paginación simple y sincrónica de los resultados de búsqueda. Use el identificador de búsqueda devuelto desde una llamada inicial a ldap_search_init_page y especifique, en el parámetro PageSize , el número de entradas que se devolverán en una página. Establezca PageSize en cero para salir de una búsqueda.
Los resultados devueltos de ldap_get_next_page_s se pueden controlar como cualquier otro resultado de búsqueda y deben liberarse, cuando termine, llamando a ldap_msgfree.
Al analizar el conjunto de resultados, es posible que el servidor devuelva una página vacía de resultados y, sin embargo, siga respondiendo con un código de retorno de LDAP_SUCCESS . Esto indica que el servidor no pudo recuperar una página de resultados, debido a un tiempo de espera u otro motivo, pero no ha completado la solicitud de búsqueda. El comportamiento adecuado en esta instancia es continuar llamando a ldap_get_next_page_s hasta que se recupera correctamente otra página de resultados, se devuelve un código de error o se devuelve LDAP_NO_RESULTS_RETURNED para indicar que se ha completado la búsqueda.
Para recuperar el resultado de la búsqueda paginada de forma asincrónica, use ldap_get_next_page.
Si se usa ldap_get_next_page_s , no es necesario que se llame a ldap_get_paged_count para registrar el número de resultados paginados devueltos por un servidor.
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 |