ldap_searchW関数 (winldap.h)
ldap_search関数は LDAP ディレクトリを検索し、一致するエントリごとに要求された属性セットを返します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_searchW(
[in] LDAP *ld,
[in] const PWSTR base,
[in] ULONG scope,
[in] const PWSTR filter,
[in] PZPWSTR attrs,
[in] ULONG attrsonly
);
パラメーター
[in] ld
セッション ハンドル。
[in] base
検索を開始するエントリの識別名を含む null で終わる文字列へのポインター。
[in] scope
検索範囲を示す次のいずれかの値を指定するデータ型。
LDAP_SCOPE_BASE
基本エントリのみを検索します。
LDAP_SCOPE_ONELEVEL
基本エントリを除き、基本エントリの下の最初のレベルのすべてのエントリを検索します。
LDAP_SCOPE_SUBTREE
基本エントリと、ベースの下のツリー内のすべてのエントリを検索します。
[in] filter
検索フィルターを指定する null で終わる文字列へのポインター。 詳細については、「 検索フィルター構文」を参照してください。
[in] attrs
一致するエントリごとに返す属性を示す、null で終わる文字列の null で終わる配列。 NULL を渡して、使用可能な属性を取得します。
[in] attrsonly
属性の型と値の両方を返す場合は 0 にする必要があるブール値。型のみが必要な場合は 0 以外。
戻り値
関数が成功すると、検索操作のメッセージ ID が返されます。
関数が失敗した場合、-1 が返され、LDAP データ構造のセッション エラー パラメーターが設定されます。
注釈
ldap_search関数は、非同期検索操作を開始します。
ld セッション ハンドルと共に ldap_set_option 関数を使用して、検索の実行方法を決定するLDAP_OPT_SIZELIMIT、LDAP_OPT_TIMELIMIT、およびLDAP_OPT_DEREFオプションを設定します。 詳細については、「 セッション オプション」を参照してください。
非同期関数として、 ldap_search は操作のメッセージ ID を返します。 メッセージ ID で ldap_result を呼び出して、操作の結果を取得します。 非同期検索操作を完了する前に取り消すには、 ldap_abandonを呼び出します。
関数が結果を直接返すようにするには、同期ルーチン ldap_search_sを使用します。 ldap_search_extまたはldap_search_ext_sを使用して、LDAP 3 サーバーおよびクライアント コントロールのサポートを実装します。
マルチスレッド: 関数 呼び出しが -1 エラー コードを返すときに LdapGetLastError を使用して実際のセッション エラー コードを取得する場合、ldap_searchの呼び出しはスレッド セーフです。
注意
winldap.h ヘッダーは、unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとしてldap_searchを定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |