InfoDirectory使用手引書 |
目次 索引 |
第3部 SDK編 | > 第5章 アプリケーション開発環境(LDAP C API) | > 5.2 関数インタフェース | > 5.2.11 エントリの削除 |
この関数は、非同期型でエントリの削除を行います。この関数では、LDAPコントロールを指定することができます。【指定形式】
int ldap_delete_ext(
LDAP *ld,
Char *dn,
LDAPControl **serverctrls,
LDAPControl **clientctrls,
int *msgidp
);【パラメタの説明】
- ld
ldap_init()またはldapssl_init()で通知された、セションハンドルを指定します。
- dn
削除するエントリの、DNのアドレスを指定します。
- serverctrls
サーバコントロールのアドレスを設定した、ポインタ配列のアドレスを指定します。サーバコントロールを使用しない場合は、このパラメタにNULLを指定します。ここで指定したサーバコントロールは、InfoDirectoryサーバへの変更要求に添付されます。
- clientctrls
クライアントコントロールのアドレスを設定した、ポインタ配列のアドレスを指定します。本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。
- msgidp
メッセージIDを格納するための変数のアドレスを指定します。
【復帰値】
この関数では、復帰値としてLDAPエラーコードを返します。
- 正常完了の場合 : LDAP_SUCCESS
- 異常完了の場合 : LDAP_SUCCESS以外のLDAPエラーコード
また、正常完了の場合には、msgidpパラメタで指定した変数にメッセージIDが設定されています。
【注意事項】
- 非同期関数の結果獲得
非同期関数の処理結果を受取る場合、ldap_result()を使用します。この時、ldap_delete_ext()の復帰値として返されたメッセージIDを指定します。詳細は、処理結果の受取り/判定を参照してください。
- 削除可能なエントリ
削除することができるのは、ツリーの末端にあるエントリだけです。
- サーバコントロール
サーバコントロールの形式については、LDAPコントロールを参照してください。
- LDAPエラーコード
LDAPエラーコードの値については、LDAPエラーコードを参照してください。
目次 索引 |