ldap_deleteA関数 (winldap.h)
ldap_delete関数は、ディレクトリ ツリーからエントリを削除します。
構文
WINLDAPAPI ULONG LDAPAPI ldap_deleteA(
[in] LDAP *ld,
[in] const PSTR 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の呼び出しはスレッド セーフです。
メモ LDAP 2 サーバーに接続する場合、アプリケーションは、他の操作を試みる前に、 ldap_bind ルーチンまたは ldap_simple_bind ルーチンのいずれかを呼び出してバインド操作を実行する必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | winldap.h |
| Library | Wldap32.lib |
| [DLL] | Wldap32.dll |