función ldap_search (winldap.h)

Artículo
03/04/2024

La función ldap_search busca en el directorio LDAP y devuelve un conjunto solicitado de atributos para cada entrada coincidente.

Sintaxis

WINLDAPAPI ULONG LDAPAPI ldap_search(
  [in] LDAP   *ld,
  [in] PSTR   base,
  [in] ULONG  scope,
  [in] PSTR   filter,
  [in] PZPSTR attrs,
  [in] ULONG  attrsonly
);

Parámetros

[in] ld

Identificador de sesión.

[in] base

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] scope

Tipo de datos que especifica uno de los valores siguientes para indicar el ámbito de 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] filter

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] attrs

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 los atributos disponibles.

[in] attrsonly

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

Valor devuelto

Si la función se realiza correctamente, devuelve el identificador de mensaje de la operación de búsqueda.

Si se produce un error en la función, devuelve –1 y establece los parámetros de error de sesión en la estructura de datos LDAP.

Comentarios

La función ldap_search inicia una operación de búsqueda asincrónica.

Use la función ldap_set_option con el identificador de sesión ld para establecer las opciones de LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT y LDAP_OPT_DEREF que determinan cómo se realiza la búsqueda. Para obtener más información, vea Opciones de sesión.

Como función asincrónica, ldap_search devuelve un identificador de mensaje para la operación. Llame a ldap_result con el identificador de mensaje para obtener el resultado de la operación. Para cancelar una operación de búsqueda asincrónica antes de que se haya completado, llame a ldap_abandon.

Para que la función devuelva los resultados directamente, use la rutina sincrónica ldap_search_s. Use ldap_search_ext o ldap_search_ext_s para implementar la compatibilidad con los controles de cliente y servidor LDAP 3.

Multithreading: las llamadas a ldap_search son seguras para subprocesos, siempre que LdapGetLastError se use para recuperar el código de error de sesión real cuando la llamada de función devuelve el código de error -1.

Nota Al conectarse a un servidor LDAP 2, la aplicación debe realizar una operación de enlace llamando a una de las rutinas de ldap_bind o ldap_simple_bind , antes de intentar otras operaciones.

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