função ldap_search (winldap.h)

Artigo
08/27/2023

A função ldap_search pesquisa o diretório LDAP e retorna um conjunto solicitado de atributos para cada entrada correspondente.

Sintaxe

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

Um identificador de sessão.

[in] base

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome diferenciado da entrada na qual iniciar a pesquisa.

[in] scope

Um tipo de dados que especifica um dos valores a seguir para indicar o escopo da pesquisa.

LDAP_SCOPE_BASE

Pesquise apenas a entrada base.

LDAP_SCOPE_ONELEVEL

Pesquise todas as entradas no primeiro nível abaixo da entrada base, excluindo a entrada base.

LDAP_SCOPE_SUBTREE

Pesquise a entrada base e todas as entradas na árvore abaixo da base.

[in] filter

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o filtro de pesquisa. Para obter mais informações, consulte Sintaxe de filtro de pesquisa.

[in] attrs

Uma matriz terminada em nulo de cadeias de caracteres terminadas em nulo que indicam quais atributos retornar para cada entrada correspondente. Passe NULL para recuperar os atributos disponíveis.

[in] attrsonly

Valor booliano que deve ser zero se os tipos de atributo e os valores devem ser retornados, diferente de zero se apenas tipos forem necessários.

Retornar valor

Se a função for bem-sucedida, ela retornará a ID da mensagem da operação de pesquisa.

Se a função falhar, ela retornará –1 e definirá os parâmetros de erro de sessão na estrutura de dados LDAP.

Comentários

A função ldap_search inicia uma operação de pesquisa assíncrona.

Use a função ldap_set_option com o identificador de sessão ld para definir as opções de LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT e LDAP_OPT_DEREF que determinam como a pesquisa é executada. Para obter mais informações, consulte Opções de sessão.

Como uma função assíncrona, ldap_search retorna uma ID de mensagem para a operação. Chame ldap_result com a ID da mensagem para obter o resultado da operação. Para cancelar uma operação de pesquisa assíncrona antes de ser concluída, chame ldap_abandon.

Para que a função retorne os resultados diretamente, use a rotina síncrona ldap_search_s. Use ldap_search_ext ou ldap_search_ext_s para implementar o suporte para controles de servidor e cliente LDAP 3.

Multithreading: as chamadas para ldap_search são thread-safe, desde que LdapGetLastError seja usado para recuperar o código de erro de sessão real quando a chamada de função retornar o código de falha -1.

Nota Ao se conectar a um servidor LDAP 2, o aplicativo deve executar uma operação de associação chamando uma das rotinas de ldap_bind ou ldap_simple_bind antes de tentar outras operações.

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