ldap_compareW 関数 (winldap.h)
ldap_compare関数を使用して、特定のエントリの属性が既知の値を保持しているかどうかを判断します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_compareW(
[in] LDAP *ld,
[in] const PWSTR dn,
[in] const PWSTR attr,
[in] PWSTR value
);
パラメーター
[in] ld
セッション ハンドル。
[in] dn
エントリの識別名を含む null で終わる文字列へのポインター。
[in] attr
比較する属性を含む null で終わる文字列へのポインター。
[in] value
属性値と比較する文字列属性値を含む null で終わる文字列へのポインター。
戻り値
関数が成功すると、比較操作のメッセージ ID が返されます。
関数が失敗した場合、-1 が返され、LDAP 構造のセッション エラー パラメーターが設定されます。 このエラーは、 LdapGetLastError を使用して取得できます。
注釈
ldap_compare関数は、属性の値を既知の文字列値と比較して、非同期比較操作を開始します。 バイナリ値を比較するには 、ldap_compare_ext または ldap_compare_ext_s を使用します。 同期比較操作 を 実行するには、 ldap_compare_sまたはldap_compare_ext_s を使用します。
非同期関数として、 ldap_compare は操作のメッセージ ID を返します。 メッセージ ID で ldap_result を呼び出して、操作の結果を取得します。 非同期操作を完了する前に取り消すには、 ldap_abandonを呼び出します。
関数が結果を直接返すには、同期ルーチン ldap_compare_sを使用します。 ldap_compare_extまたはldap_compare_ext_sを使用して、LDAP 3 サーバーおよびクライアント コントロールのサポートを有効にします。
マルチスレッド: 関数 呼び出しが -1 エラー コードを返すときに LdapGetLastError を使用して実際のセッション エラー コードを取得する場合、ldap_compareの呼び出しはスレッド セーフです。
注意
winldap.h ヘッダーは、ldap_compareをエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |