ldap_search_init_page関数 (winldap.h)
ldap_search_init_page関数は、単純なページ結果検索の検索ブロックを初期化します。 この関数は LDAP 3 でサポートされています。
構文
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
);
パラメーター
[in] ExternalHandle
セッション ハンドル。
[in] DistinguishedName
検索を開始するエントリの識別名を含む null で終わる文字列へのポインター。
[in] ScopeOfSearch
検索の範囲を示す次のいずれかの値を指定するデータ型。
LDAP_SCOPE_BASE
基本エントリのみを検索します。
LDAP_SCOPE_ONELEVEL
基本エントリを除き、基本エントリの下の最初のレベルのすべてのエントリを検索します。
LDAP_SCOPE_SUBTREE
ベース エントリと、ベースの下のツリー内のすべてのエントリを検索します。
[in] SearchFilter
検索フィルターを指定する null で終わる文字列へのポインター。 詳細については、「 検索フィルター構文」を参照してください。
[in] AttributeList
一致するエントリごとに返す属性を示す null で終わる文字列の null で終わる配列。 NULL を渡して、使用可能なすべての属性を取得します。
[in] AttributesOnly
属性の型と値の両方を返す場合は 0、型のみを返す場合は 0 以外のブール値。
[in] ServerControls
LDAP サーバー コントロールの一覧。
[in] ClientControls
クライアント コントロールの一覧。
[in] PageTimeLimit
サーバーがページを返すのをクライアントが待機する時間の値 (秒単位)。
[in] TotalSizeLimit
クライアントが受け入れるエントリの最大数。 TotalSizeLimit 値は、ページ検索内の個々のページにのみ影響します (ページ検索全体には影響しません)。 そのため、 TotalSizeLimit がページ サイズより大きい場合、 TotalSizeLimit は無効になります。
[in] SortKeys
LDAPSortKey 構造体へのポインター。属性の種類、順序ルール、および検索の方向を指定します。
戻り値
関数が成功すると、 LDAPSearch 構造体へのポインターが返されます。
関数が失敗した場合は、返される値は NULL です。 LdapGetLastError または GetLastError を使用してエラー コードを取得します。
返された構造体を解放するには、 ldap_search_abandon_page を呼び出します。
注釈
ldap_search_init_page関数は、ページ検索を管理するための LDAPSearch 構造体を作成し、構造体へのハンドルを返します。 ldap_get_next_page、ldap_get_next_page_s、およびldap_get_paged_count関数には、パラメーターとしてこの検索ハンドルが必要です。 ページ検索が完了したら、 ldap_search_abandon_page を呼び出して、この構造体とそのハンドルを解放します。
サーバーがページ結果検索をサポートしているかどうかを判断するには、1.2.840.113556.1.4.319 のオブジェクト識別子 (OID) のルートから supportedControl プロパティをチェックします。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |