funzione ldap_search_init_page (winldap.h)

La funzione ldap_search_init_page inizializza un blocco di ricerca per una semplice ricerca di risultati di paging. Questa funzione è supportata in LDAP 3.

Sintassi

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
);

Parametri

[in] ExternalHandle

Handle di sessione.

[in] DistinguishedName

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

[in] ScopeOfSearch

Tipo di dati che specifica uno dei valori seguenti per indicare l'ambito della 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] SearchFilter

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

[in] AttributeList

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

[in] AttributesOnly

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

[in] ServerControls

Elenco di controlli server LDAP.

[in] ClientControls

Elenco di controlli client.

[in] PageTimeLimit

Valore di ora, in secondi, che il client attenderà che il server restituisca una pagina.

[in] TotalSizeLimit

Numero massimo di voci accettate dal client. Il valore TotalSizeLimit interessa solo le singole pagine all'interno della ricerca con paging (non la ricerca di paging complessiva). Pertanto, se TotalSizeLimit è maggiore delle dimensioni della pagina, TotalSizeLimit non avrà alcun effetto.

[in] SortKeys

Puntatore a una struttura LDAPSortKey , che specifica il tipo di attributo, la regola di ordinamento e la direzione per la ricerca.

Valore restituito

Se la funzione ha esito positivo, restituisce un puntatore a una struttura LDAPSearch .

Se la funzione ha esito negativo, il valore restituito è NULL. Usare LdapGetLastError o GetLastError per recuperare il codice di errore.

Chiamare il ldap_search_abandon_page per liberare la struttura restituita.

Commenti

La funzione ldap_search_init_page crea una struttura LDAPSearch per la gestione delle ricerche di paging e restituisce un handle alla struttura. Le funzioni ldap_get_next_page, ldap_get_next_page_s e ldap_get_paged_count richiedono questo handle di ricerca come parametro. Al termine della ricerca con paging, chiamare ldap_search_abandon_page per liberare questa struttura e il relativo handle.

Per determinare se un server supporta le ricerche di risultati di paging, controllare la proprietà supportedControl all'esterno della radice per un identificatore di oggetto (OID) di 1.2.840.113556.1.4.319.

Requisiti

Vedi anche

Funzioni

Getlasterror

LDAPSearch

LDAPSortKey

LdapGetLastError

ldap_get_next_page

ldap_get_next_page_s

ldap_search_abandon_page