1.20.9 エントリの削除インタフェース

関数名	関数の説明
ldap_delete()	指定されたエントリを削除します。（非同期型）
ldap_delete_s()	指定されたエントリを削除します。（同期型）
ldap_delete_ext()	指定されたエントリを削除します。 (非同期型、LDAP V3拡張関数)
ldap_delete_ext_s()	指定されたエントリを削除します。 (同期型、LDAP V3拡張関数)

下位エントリがあるエントリに対して、一度の操作で、削除することはできません。リーフ(最下位)エントリから順に、削除してください。

名前

ldap_delete

形式

  #include "idldap.h"
  int  ldap_delete(
          LDAP  *ld,
          const char  *dn );

機能説明

この関数は、非同期型でエントリを削除します。削除することができるのは、リーフエントリ(ツリーの末端にあるエントリ)だけです。

非同期関数の処理結果を受け取る場合、ldap_result()を使用します。この時、ldap_delete()の復帰値として返されたメッセージIDを指定します。詳細は、“処理結果の受取り/判定”を参照してください。

ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 削除するエントリの、DNのアドレスを指定します。

復帰値

この関数は、復帰値として以下の値を返します。

正常終了の場合：メッセージID
異常終了の場合： -1
異常終了の場合のエラー原因は、ldap_get_option()のLDAP_OPT_RESULT_CODEオプションで参照してください。

名前

ldap_delete_s

形式

  #include "idldap.h"
  int  ldap_delete_s(
          LDAP  *ld,
          const char  *dn );

機能説明

この関数は、同期型でエントリを削除します。削除することができるのは、リーフエントリ(ツリーの末端にあるエントリ)だけです。

ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 削除するエントリの、DNのアドレスを指定します。

復帰値

この関数では、復帰値としてLDAPエラーコードを返します。LDAPエラーコードの値については、“メッセージ集”の“LDAPエラーコード”を参照してください。

正常終了の場合： LDAP_SUCCESS
異常終了の場合： LDAP_SUCCESS以外のLDAPエラーコード

名前

ldap_delete_ext

形式

  #include "idldap.h"
  int  ldap_delete_ext(
          LDAP  *ld,
          const char  *dn,
          LDAPControl  **serverctrls,
          LDAPControl  **clientctrls,
          int  *msgidp );

機能説明

この関数は、非同期型でエントリを削除します。削除することができるのは、リーフエントリ(ツリーの末端にあるエントリ)だけです。

非同期関数の処理結果を受け取る場合、ldap_result()を使用します。この時、ldap_delete()の復帰値として返されたメッセージIDを指定します。詳細は、“処理結果の受取り/判定”を参照してください。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 削除するエントリの、DNのアドレスを指定します。

serverctrls: Interstage ディレクトリサービスではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。

clientctrls: 本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。

msgidp: メッセージIDを格納するための変数のアドレスを指定します。

復帰値

この関数では、復帰値としてLDAPエラーコードを返します。LDAPエラーコードの値については、“メッセージ集”の“LDAPエラーコード”を参照してください。

正常終了の場合： LDAP_SUCCESS
異常終了の場合： LDAP_SUCCESS以外のLDAPエラーコード

また、正常終了の場合には、msgidpパラメタで指定した変数にメッセージIDが設定されています。

名前

ldap_delete_ext_s

形式

  #include "idldap.h"
  int  ldap_delete_ext_s(
          LDAP  *ld,
          const char  *dn,
          LDAPControl  **serverctrls,
          LDAPControl  **clientctrls );

機能説明

この関数は、同期型でエントリを削除します。削除することができるのは、リーフエントリ(ツリーの末端にあるエントリ)だけです。

ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

パラメタ

ld: ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。

dn: 削除するエントリの、DNのアドレスを指定します。

serverctrls: Interstage ディレクトリサービスではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。

clientctrls: 本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。

復帰値

この関数では、復帰値としてLDAPエラーコードを返します。LDAPエラーコードの値については、“メッセージ集”の“LDAPエラーコード”を参照してください。

正常終了の場合： LDAP_SUCCESS
異常終了の場合： LDAP_SUCCESS以外のLDAPエラーコード

1.20.9 エントリの削除インタフェース

1.20.9.1 ldap_delete()

1.20.9.2 ldap_delete_s()

1.20.9.3 ldap_delete_ext()

1.20.9.4 ldap_delete_ext_s()