ldap_modrdn2_s

Synchronously modifies the relative distinguished name of the specified entry. This function has been deprecated; use the ldap_rename_s function.

Library:*ldapsdk.*
NDS Version:7.xx or higher
Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

  #include <ldap.h>
  
  int ldap_modrdn2_s (
     LDAP         *ld,
     const char   *dn,
     const char   *newrdn,
     int           deleteoldrdn);

Parameters

ld

(IN) Points to the handle for the LDAP session.

dn

(IN) Points to the distinguished name of the entry to modify.

newrdn

(IN) Points to the new relative distinguished name for the entry. The entry's parent must remain the same.

deleteoldrdn

(IN) Specifies whether the old RDN should be retained or deleted.

  • Zero indicates that the old RDN should be retained. If you choose this option, the attribute will contain both names (the old and the new).

  • Non-zero indicates that the old RDN should be deleted.

Return Values

0x00

LDAP_SUCCESS

Non-zero

Failure. For a complete list, see LDAP Return Codes.

Remarks

The ldap_modrdn2_s function has been replaced by the ldap_rename function. Unless you need this older function for backwards compatibility, use the newer ldap_rename_s function.

See Also

ldap_rename, ldap_rename_s