ldap_create_page_control関数 (winldap.h)
ldap_create_page_control関数を使用して、ページング結果の基本的なコントロールを作成します。 コントロールのサポートは LDAP 3 で有効に使用できますが、ページ コントロールがサポートされているかどうかは、特定のサーバーに依存します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_create_page_control(
[in] PLDAP ExternalHandle,
[in] ULONG PageSize,
[in] berval *Cookie,
[in] UCHAR IsCritical,
[out] PLDAPControlA *Control
);
パラメーター
[in] ExternalHandle
セッション ハンドル。
[in] PageSize
各ページで返されるエントリの数。
[in] Cookie
サーバーが結果セット内の位置を決定するために使用する berval 構造体へのポインター。 これは、直接アクセスしてはならない不透明な構造です。 ldap_create_page_controlへの最初の呼び出しの場合は NULL に設定します。
[in] IsCritical
このコントロールが検索にとって重要かどうかをサーバーに通知します。
[out] Control
新しく作成されたコントロールへのポインター。
戻り値
この関数は WINLDAPAPI ULONG LDAPAPI を返します。
解説
ldap_create_page_control関数は、単純なページ結果コントロールを作成します。 コントロールを使用すると、クライアントは LDAP サーバーが検索操作の結果を返す速度を指定できます。 これは、クライアントに限られたリソースがあり、特定の LDAP クエリから結果セット全体を処理できない場合や、クライアント/サーバー接続が遅い場合に便利です。
paged-results コントロールを作成するには、1 つのページで返されるエントリの数を指定します。 このコントロールをサポートできない場合でも通常どおり結果を返すには、 IsCritical パラメーターを FALSE に設定 します。
この関数はコントロールを作成します。サーバーがコントロールをサポートしていることを確認しないため、サーバーがコントロールをサポートしていない場合は LDAP_UNAVAILABLE_CRIT_EXTENSION が返されません。 ただし、 LDAP_NO_MEMORY や LDAP_PARAM_ERRORなど、他の標準 LDAP 戻り値を返すことができます。
ldap_create_page_controlが正常に返されたら、ldap_search_extまたはldap_search_ext_sの呼び出しで、新しく作成されたコントロールをサーバー コントロールの一覧に含めます。 サーバーから結果の最初のページが返されたら、 ldap_parse_result を呼び出して結果の最初のページを取得します。
コントロール が 不要になった場合は、ldap_control_freeを呼び出します。
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |