Interstage Application Server リファレンスマニュアル（API編）

1.20.7.1 ldap_rename()

名前

　ldap_rename

形式

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

機能説明

　この関数は、非同期型でエントリ名の変更を行います。

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

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

パラメタ

　ld

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

　dn

　名前を変更するエントリの、DNのアドレスを指定します。

　newrdn

　このエントリの、新しいRDNのアドレスを指定します。

　newparent

　このパラメタでは、新しいエントリの親となるエントリの、DNのアドレスを指定します。新しいエントリをもとのエントリと同じ場所に置く場合は、このパラメタにNULLを指定します。

　deleteoldrdn

　このパラメタでは、もとのRDNに該当する属性値を、エントリから削除するかどうかを指定します。

• もとのRDNに該当する属性値を削除する場合 ： 0以外の値
• もとのRDNに該当する属性値を削除しない場合 ： 0

　0を指定した場合、RDNではない属性値として、エントリに残されます。

　serverctrls

　Smart Repositoryではサーバコントロールをサポートしていないため、このパラメタにはNULLを指定します。

　clientctrls

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

　msgidp

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

復帰値

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

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

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