función ldap_search_init_page (winldap.h)

Artículo
03/13/2024

La función ldap_search_init_page inicializa un bloque de búsqueda para una búsqueda simple de resultados paginados. Esta función se admite en LDAP 3.

Sintaxis

WINLDAPAPI PLDAPSearch LDAPAPI ldap_search_init_page(
  [in] PLDAP        ExternalHandle,
  [in] const PSTR   DistinguishedName,
  [in] ULONG        ScopeOfSearch,
  [in] const PSTR   SearchFilter,
  [in] PZPSTR       AttributeList,
  [in] ULONG        AttributesOnly,
  [in] PLDAPControl *ServerControls,
  [in] PLDAPControl *ClientControls,
  [in] ULONG        PageTimeLimit,
  [in] ULONG        TotalSizeLimit,
  [in] PLDAPSortKey *SortKeys
);

Parámetros

[in] ExternalHandle

Identificador de sesión.

[in] DistinguishedName

Puntero a una cadena terminada en null que contiene el nombre distintivo de la entrada en la que se va a iniciar la búsqueda.

[in] ScopeOfSearch

Tipo de datos que especifica uno de los siguientes valores para indicar el ámbito de la búsqueda.

LDAP_SCOPE_BASE

Busque solo la entrada base.

LDAP_SCOPE_ONELEVEL

Busque todas las entradas del primer nivel por debajo de la entrada base, excepto la entrada base.

LDAP_SCOPE_SUBTREE

Busque la entrada base y todas las entradas del árbol debajo de la base.

[in] SearchFilter

Puntero a una cadena terminada en null que especifica el filtro de búsqueda. Para obtener más información, vea Sintaxis de filtro de búsqueda.

[in] AttributeList

Matriz terminada en null de cadenas terminadas en null que indican qué atributos se van a devolver para cada entrada coincidente. Pase NULL para recuperar todos los atributos disponibles.

[in] AttributesOnly

Valor booleano que debe ser cero si se van a devolver los tipos de atributo y los valores, distinto de cero si solo se van a devolver los tipos.

[in] ServerControls

Lista de controles de servidor LDAP.

[in] ClientControls

Lista de controles de cliente.

[in] PageTimeLimit

Valor de tiempo, en segundos, que el cliente esperará a que el servidor devuelva una página.

[in] TotalSizeLimit

Número máximo de entradas que aceptará el cliente. El valor TotalSizeLimit afecta solo a las páginas individuales dentro de la búsqueda paginada (no a la búsqueda paginada general). Por lo tanto, si TotalSizeLimit es mayor que el tamaño de página, TotalSizeLimit no tendrá ningún efecto.

[in] SortKeys

Puntero a una estructura LDAPSortKey , que especifica el tipo de atributo, la regla de ordenación y la dirección de la búsqueda.

Valor devuelto

Si la función se ejecuta correctamente, devuelve un puntero a una estructura LDAPSearch .

Si la función no se realiza correctamente, el valor devuelto es NULL. Use LdapGetLastError o GetLastError para recuperar el código de error.

Llame al ldap_search_abandon_page para liberar la estructura devuelta.

Comentarios

La función ldap_search_init_page crea una estructura LDAPSearch para administrar búsquedas paginadas y devuelve un identificador a la estructura. Las funciones ldap_get_next_page, ldap_get_next_page_s y ldap_get_paged_count requieren este identificador de búsqueda como parámetro. Cuando se complete la búsqueda paginada, llame a ldap_search_abandon_page para liberar esta estructura y su identificador.

Para determinar si un servidor admite búsquedas de resultados paginados, compruebe la propiedad supportedControl desactivada de la raíz de un identificador de objeto (OID) de 1.2.840.113556.1.4.319.

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