ldap_get_next_page_s 関数 (winldap.h)
ldap_get_next_page_s関数は、同期ページ検索結果のシーケンス内の次のページを返します。
構文
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
);
パラメーター
[in] ExternalHandle
セッション ハンドル。
[in] SearchHandle
検索ブロック ハンドル。
[in] timeout
クライアントが呼び出しが返されるのを待機する時間値 (秒単位)。
[in] PageSize
1 ページで返されるエントリの数。
[out] TotalCount
結果セット全体のエントリの合計数のサーバー見積もり。 値 0 は、サーバーが見積もりを提供できないことを示します。
[out] Results
結果を含む LDAPMessage 構造体へのポインター。
戻り値
サーバーが null Cookie (非継続) を返す場合、値は LDAP_NO_RESULTS_RETURNED。 それ以外の場合、クライアントは LDAP_SUCCESSを返すことによって継続 (使用可能なデータの追加) を通知します。
それ以外の場合、関数はエラーに関連するエラー コードの戻り値を返します。 詳細については、「 戻り値」を参照してください。
注釈
ldap_get_next_page_s関数は、検索結果の単純で同期的なページングのためのインターフェイスの一部です。 最初の呼び出しから返された検索ハンドルを使用して ldap_search_init_page し、 PageSize パラメーターで、ページで返されるエントリの数を指定します。 検索を終了するには、 PageSize を 0 に設定します。
ldap_get_next_page_sから返された結果は、他の検索結果として処理できます。終了したら、ldap_msgfreeを呼び出して解放する必要があります。
結果セットを解析するときに、サーバーが空の結果ページを返しても、 LDAP_SUCCESS 戻りコードで応答する可能性があります。 これは、タイムアウトなどの理由により、サーバーが結果のページを取得できなかったが、検索要求を完了しなかったことを示します。 このインスタンスの適切な動作は、結果の別のページが正常に取得されるか、エラー コードが返されるか、検索が完了したことを示すLDAP_NO_RESULTS_RETURNEDが返されるまで、ldap_get_next_page_sを呼び出し続けます。
ページングされた検索結果を非同期的に取得するには、 ldap_get_next_pageを使用します。
ldap_get_next_page_sを使用する場合、サーバーから返されたページ結果の数を記録するためにldap_get_paged_countを呼び出す必要はありません。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |