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