ldap_get_next_page関数 (winldap.h)
ldap_get_next_page関数は、非同期ページ検索結果のシーケンス内の次のページを返します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_get_next_page(
[in] PLDAP ExternalHandle,
[in] PLDAPSearch SearchHandle,
[in] ULONG PageSize,
[out] ULONG *MessageNumber
);
パラメーター
[in] ExternalHandle
セッション ハンドル。
[in] SearchHandle
検索ブロック ハンドル。
[in] PageSize
1 ページで返されるエントリの数。
[out] MessageNumber
要求のメッセージ ID。
戻り値
関数が成功した場合、戻り値は LDAP_SUCCESS。
関数が失敗すると、エラー コードの戻り値が返されます。 詳細については、「 戻り値」を参照してください。
注釈
ldap_get_next_page関数は、検索結果の単純な非同期ページングのためのインターフェイスの一部です。 最初の呼び出しから返された検索ハンドルを使用して ldap_search_init_page し、 PageSize パラメーターで、ページで返されるエントリの数を指定します。 検索を破棄するには、 PageSize を 0 に設定します。
ldap_get_next_pageを呼び出すたびに、ldap_resultを使用してサーバーから返される結果のセットごとにldap_get_paged_countを呼び出す必要があることに注意してください。 これにより、LDAP ランタイムは、サーバーが返した Cookie を保存して、検索状態を維持できます。 ldap_get_paged_countを呼び出す以外に、ldap_get_next_pageから返された結果は他の検索結果として処理でき、ldap_msgfreeを呼び出して完了したら解放する必要があります。
結果セットを解析するときは、サーバーが空の結果ページを返しても、 LDAP_SUCCESS 戻り値で応答する可能性があることに注意してください。 これは、タイムアウトなどの理由により、サーバーが結果のページを取得できなかったが、検索要求が完了しなかったことを示します。 この場合の適切な動作は、結果の別のページが正常に取得されるか、エラー コードが返されるか、検索が完了したことを示すLDAP_NO_RESULTS_RETURNEDが返されるまで、ldap_get_next_pageを呼び出し続けます。
ページングされた検索結果を同期的に取得する場合は、 ldap_get_next_page_sを使用します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |