6.2.9.1 ldap

Interstage Application Server Smart Repository運用ガイド

目次索引

第6章アプリケーションの作成(C API)

> 6.2 関数インタフェース

> 6.2.9 エントリ名の変更

6.2.9.1 ldap_rename

　この関数は、非同期型でエントリ名の変更を行います。この関数では、LDAPコントロールを指定することができます。

【指定形式】

int  ldap_rename(
        LDAP  *ld,
        char  *dn,
        char  *newrdn,
        char  *newparent, 
        int  deleteoldrdn, 
        LDAPControl  **serverctrls,
        LDAPControl  **clientctrls, 
        int  *msgidp 
        );

【パラメタの説明】

ld
　ldap_init()またはldapssl_init()で通知された、セションハンドルを指定します。
dn
　名前を変更するエントリの、DNのアドレスを指定します。
newrdn
　このエントリの、新しいRDNのアドレスを指定します。
newparent
　このパラメタでは、新しいエントリの親となるエントリの、DNのアドレスを指定します。新しいエントリをもとのエントリと同じ場所に置く場合は、このパラメタにNULLを指定します。LDAP V2プロトコルを使用する場合は、このパラメタにNULLを指定します。
deleteoldrdn
　このパラメタでは、もとのRDNに該当する属性値を、エントリから削除するか否かを指定します。
- もとのRDNに該当する属性値を削除する場合： 0以外の値
- もとのRDNに該当する属性値を削除しない場合： 0
　0を指定した場合、RDNではない属性値として、エントリに残されます。
serverctrls
　Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。
clientctrls
　本ライブラリではクライアントコントロールをサポートしていないため、このパラメタにNULLを指定します。
msgidp
　メッセージIDを格納するための変数のアドレスを指定します。

【復帰値】

　この関数では、復帰値としてLDAPエラーコードを返します。

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

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

【注意事項】

非同期関数の結果獲得
　非同期関数の処理結果を受け取る場合、ldap_result()を使用します。この時、ldap_rename()の復帰値として返されたメッセージIDを指定します。詳細は、“処理結果の受取り／判定”を参照してください。
親エントリの指定
　親エントリは、LDAP V3プロトコルの場合のみ指定することができます。LDAP V2プロトコルを使用する場合は、newparentパラメタにNULLを指定します。
LDAPエラーコード
　LDAPエラーコードの値については、“LDAPエラーコード”を参照してください。
SSLエラーコード
　ldapssl_init()で獲得したセションハンドルを使用している場合、SSLライブラリで発生したエラーをldapssl_error()で参照することができます。

目次索引