Funzione ldap_get_next_page_s (winldap.h)

La funzione ldap_get_next_page_s restituisce la pagina successiva in una sequenza di risultati della ricerca a pagina sincrona.

Sintassi

WINLDAPAPI ULONG LDAPAPI ldap_get_next_page_s(
  [in]  PLDAP       ExternalHandle,
  [in]  PLDAPSearch SearchHandle,
  [in]  l_timeval   *timeout,
  [in]  ULONG       PageSize,
  [out] ULONG       *TotalCount,
  [out] LDAPMessage **Results
);

Parametri

[in] ExternalHandle

Handle sessione.

[in] SearchHandle

Handle di blocco di ricerca.

[in] timeout

Valore di tempo, in secondi, che il client attenderà la restituzione della chiamata.

[in] PageSize

Numero di voci da restituire in una singola pagina.

[out] TotalCount

Stima del server del numero totale di voci nell'intero set di risultati. Un valore pari a zero indica che il server non può fornire una stima.

[out] Results

Puntatore alla struttura LDAPMessage contenente i risultati.

Valore restituito

Se il server restituisce un cookie Null (non continuazione), il valore è LDAP_NO_RESULTS_RETURNED. In caso contrario, il client segnala una continuazione (più dati disponibili) restituendo LDAP_SUCCESS.

Se la funzione ha esito negativo, restituisce il valore restituito dal codice di errore correlato all'errore. Per altre informazioni, vedere Valori restituiti.

Commenti

La funzione ldap_get_next_page_s fa parte dell'interfaccia per un paging semplice e sincrono dei risultati della ricerca. Usare l'handle di ricerca restituito da una chiamata iniziale a ldap_search_init_page e specificare, nel parametro PageSize il numero di voci da restituire in una pagina. Impostare PageSize su zero per uscire da una ricerca.

I risultati restituiti da ldap_get_next_page_s possono essere gestiti come qualsiasi altro risultato di ricerca e devono essere liberati, al termine, chiamando ldap_msgfree.

Quando si analizza il set di risultati, è possibile che il server restituisca una pagina vuota dei risultati e ancora risponda con un codice restituito LDAP_SUCCESS . Ciò indica che il server non è riuscito a recuperare una pagina dei risultati, a causa di un timeout o di un altro motivo, ma non è stato completato la richiesta di ricerca. Il comportamento corretto in questa istanza consiste nel continuare a chiamare ldap_get_next_page_s finché non viene recuperata un'altra pagina di risultati, viene restituito un codice di errore o LDAP_NO_RESULTS_RETURNED viene restituito per indicare che la ricerca è completa.

Per recuperare il risultato della ricerca in pagina in modo asincrono, usare ldap_get_next_page.

Se viene usato ldap_get_next_page_s , non è necessario che ldap_get_paged_count venga chiamato per registrare il numero di risultati paginati restituiti da un server.

Requisiti

Vedi anche

Funzioni

LDAPMessage

Valori restituiti

ldap_get_next_page

ldap_get_paged_count

ldap_msgfree

ldap_search_init_page