Compartir a través de


función ldap_create_page_control (winldap.h)

Use la función ldap_create_page_control para crear un control básico para paginar los resultados. La compatibilidad con los controles está disponible con LDAP 3, pero si el control de página es compatible o no depende del servidor determinado.

Sintaxis

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

Identificador de sesión.

[in] PageSize

Número de entradas que se van a devolver en cada página.

[in] Cookie

Puntero a una estructura berval que el servidor usa para determinar su ubicación en el conjunto de resultados. Se trata de una estructura opaca a la que no se debe acceder directamente. Establezca en NULL para la primera llamada a ldap_create_page_control.

[in] IsCritical

Notifica al servidor si este control es crítico para la búsqueda.

[out] Control

Puntero al control recién creado.

Valor devuelto

Esta función devuelve LDAPAPI de WINLDAPAPI ULONG.

Comentarios

La función ldap_create_page_control crea un control de resultados paginados simple. El control permite al cliente especificar la velocidad a la que un servidor LDAP devuelve los resultados de una operación de búsqueda. Esto resulta útil cuando el cliente tiene recursos limitados y es posible que no pueda procesar todo el conjunto de resultados de una consulta LDAP determinada o cuando la conexión de cliente o servidor sea lenta.

Para crear el control paged-results, especifique el número de entradas que se van a devolver en una sola página. Para devolver resultados normalmente, aunque no admita este control, establezca el parámetro IsCritical en FALSE.

Esta función crea el control : no comprueba que el servidor lo admita y, por consiguiente, 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.

Cuando ldap_create_page_control devuelve correctamente, incluya el control recién creado en la lista de controles de servidor de una llamada a ldap_search_ext o a ldap_search_ext_s. Cuando el servidor devuelve la primera página de resultados, llame a ldap_parse_result para recuperar la primera página de resultados.

Llame a ldap_control_free cuando el control ya no sea necesario.

Requisitos

   
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

LDAP_PAGED_RESULT_OID_STRING

ldap_control_free

ldap_parse_page_control

ldap_parse_result

ldap_search_ext

ldap_search_ext_s