funzione ldap_search (winldap.h)

Articolo
03/04/2024

La funzione ldap_search cerca nella directory LDAP e restituisce un set richiesto di attributi per ogni voce corrispondente.

Sintassi

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

Parametri

[in] ld

Handle di sessione.

[in] base

Puntatore a una stringa con terminazione Null contenente il nome distinto della voce in corrispondenza della quale avviare la ricerca.

[in] scope

Tipo di dati che specifica uno dei valori seguenti per indicare l'ambito di ricerca.

LDAP_SCOPE_BASE

Cercare solo la voce di base.

LDAP_SCOPE_ONELEVEL

Cercare tutte le voci nel primo livello sotto la voce di base, escludendo la voce di base.

LDAP_SCOPE_SUBTREE

Cercare la voce di base e tutte le voci nell'albero sotto la base.

[in] filter

Puntatore a una stringa con terminazione Null che specifica il filtro di ricerca. Per altre informazioni, vedere Sintassi del filtro di ricerca.

[in] attrs

Matrice con terminazione Null di stringhe con terminazione Null che indicano quali attributi restituire per ogni voce corrispondente. Passare NULL per recuperare gli attributi disponibili.

[in] attrsonly

Valore booleano che deve essere zero se devono essere restituiti entrambi i tipi di attributo e i valori, diverso da zero se sono necessari solo i tipi.

Valore restituito

Se la funzione ha esito positivo, restituisce l'ID messaggio dell'operazione di ricerca.

Se la funzione ha esito negativo, restituisce –1 e imposta i parametri di errore della sessione nella struttura dei dati LDAP.

Commenti

La funzione ldap_search avvia un'operazione di ricerca asincrona.

Usare la funzione ldap_set_option con l'handle di sessione ld per impostare le opzioni LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT e LDAP_OPT_DEREF che determinano come viene eseguita la ricerca. Per altre informazioni, vedere Opzioni di sessione.

Come funzione asincrona, ldap_search restituisce un ID messaggio per l'operazione. Chiamare ldap_result con l'ID del messaggio per ottenere il risultato dell'operazione. Per annullare un'operazione di ricerca asincrona prima del completamento, chiamare ldap_abandon.

Per fare in modo che la funzione restituisca direttamente i risultati, usare la routine sincrona ldap_search_s. Usare ldap_search_ext o ldap_search_ext_s per implementare il supporto per i controlli client e server LDAP 3.

Multithreading: le chiamate a ldap_search sono thread-safe, purché LdapGetLastError venga usato per recuperare il codice di errore di sessione effettivo quando la chiamata di funzione restituisce il codice di errore -1.

Nota Quando ci si connette a un server LDAP 2, l'applicazione deve eseguire un'operazione di associazione chiamando una delle routine ldap_bind o ldap_simple_bind prima di tentare altre operazioni.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista
Server minimo supportato	Windows Server 2008
Piattaforma di destinazione	Windows
Intestazione	winldap.h
Libreria	Wldap32.lib
DLL	Wldap32.dll