5.2.8 エントリの削除

Interstage Application Server Smart Repository運用ガイド

目次索引

5.2.8 エントリの削除

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

ldap_delete

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

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

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　削除するエントリの、DNのアドレスを指定します。

【復帰値】

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

正常完了の場合：メッセージID
異常完了の場合： -1
　異常完了の場合、以下の原因が考えられます。
- パラメタの指定に誤りがあります。
- 使用可能なメモリが不足しました。

ldap_delete_s

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

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　削除するエントリの、DNのアドレスを指定します。

【復帰値】

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

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

ldap_delete_ext

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

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

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　削除するエントリの、DNのアドレスを指定します。
serverctrls
　Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。
clientctrls
　本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。
msgidp
　メッセージIDを格納するための変数のアドレスを指定します。

【復帰値】

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

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

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

ldap_delete_ext_s

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

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

【指定形式】

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

【パラメタの説明】

ld
　ldap_init()、またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　削除するエントリの、DNのアドレスを指定します。
serverctrls
　Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。
clientctrls
　本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにはNULLを指定します。

【復帰値】

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

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

目次索引