ldap_rename_ext (Compact 2013)

3/26/2014

This function starts an asynchronous operation that changes the distinguished name of an entry in the directory. This function is available beginning with LDAP 3.

Syntax

ULONG ldap_rename_ext(
  LDAP* ld,
  UNICODE PTCHAR dn,
  UNICODE PTCHAR NewRDN,
  UNICODE PTCHAR NewParent,
  INT DeleteOldRdn,
  LDAPControl** ServerControls,
  LDAPControl** ClientControls,
  ULONG* MessageNumber
);

Parameters

• ld
  [in] Session handle.

• dn
  [in] Distinguished name of the entry to be renamed.

• NewRDN
  [in] New relative distinguished name for the entry.

• NewParent
  [in] Distinguished name of the new parent for this entry. This parameter enables you to move the entry to a new parent container.

• DeleteOldRdn
  [in] TRUE if the old relative distinguished name should be deleted. FALSE if the old relative distinguished name should be retained.

• ServerControls
  [in] List of LDAP server controls.

• ClientControls
  [in] List of client controls.

• MessageNumber
  [out] Pointer to a variable that receives the message identifier for this asynchronous operation. Use this identifier with the ldap_result function to retrieve the results of the operation.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code. See the LDAP_RETCODE enumeration for a list of possible return values.

Remarks

This function provides extended renaming operations. For example, you can pass controls that separate the parent from the relative distinguished name, for clarity.

In a multithreading environment, calls to this function are thread-safe.

Requirements

See Also

Reference

LDAP Directory Entry Functions
LDAP_RETCODE
ldap_result