ldap_deleteW関数 (winldap.h)
ldap_delete関数は、ディレクトリ ツリーからエントリを削除します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_deleteW(
[in] LDAP *ld,
[in] const PWSTR dn
);
パラメーター
[in] ld
セッション ハンドル。
[in] dn
削除するエントリの識別名を含む null で終わる文字列へのポインター。
戻り値
関数が成功すると、削除操作のメッセージ ID が返されます。
関数が失敗した場合、戻り値は –1 で、関数は LDAP データ構造のセッション・エラー・パラメーターを設定します。 この値を取得するには、 LdapGetLastError を使用します。
解説
ldap_deleteを呼び出して、ディレクトリ ツリーからリーフ エントリを削除します。 LDAP では、1 回の操作でサブツリー全体の削除がサポートされないことに注意してください。 非同期関数として、 ldap_delete は操作のメッセージ ID を返します。 操作 の結果を 取得するには、メッセージ ID を使用して ldap_result を呼び出します。 非同期削除操作を完了する前に取り消すには、 ldap_abandonを呼び出します。
関数が結果を直接返すには、同期ルーチン ldap_delete_sを使用します。 ldap_delete_extまたはldap_delete_ext_sを使用して、LDAP 3 サーバーおよびクライアント コントロールのサポートを有効にします。
マルチスレッド: 関数 呼び出しが -1 エラー コードを返すときに LdapGetLastError を使用して実際のセッション エラー コードを取得する場合、ldap_deleteの呼び出しはスレッド セーフです。
注意
winldap.h ヘッダーは、ldap_deleteをエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |