InfoDirectory使用手引書

5.2.9.2 ldap_rename_s

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

【指定形式】

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

【パラメタの説明】

• ld

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

• dn

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

• newrdn

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

• newparent

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

• deleteoldrdn

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

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

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

• serverctrls

  　サーバコントロールのアドレスを設定した、ポインタ配列のアドレスを指定します。 サーバコントロールを使用しない場合は、このパラメタにNULLを指定します。ここで指定したサーバコントロールは、InfoDirectoryサーバへの変更要求に添付されます。

• clientctrls

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

【復帰値】

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

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

【注意事項】

• 親エントリの指定

  　親エントリは、LDAP V3プロトコルの場合のみ指定することができます。LDAP V2プロトコルを使用する場合は、newparentパラメタにNULLを指定します。

• サーバコントロール

  　サーバコントロールは、LDAP V3プロトコルの場合のみ指定することができます。LDAP V2プロトコルを使用する場合は、serverctrlsパラメタとclientctrlsパラメタにNULLを指定します。サーバコントロールの形式については、LDAPコントロールを参照してください。

• LDAPエラーコード

  　LDAPエラーコードの値については、LDAPエラーコードを参照してください。