ldap_rename_ext function

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

Syntax

ULONG ldap_rename_ext(
  _In_  LDAP         *ld,
  _In_  PWCHAR       dn,
  _In_  PWCHAR       NewRDN,
  _In_  PWCHAR       NewParent,
  _In_  INT          DeleteOldRdn,
  _In_  PLDAPControl *ServerControls,
  _In_  PLDAPControl *ClientControls,
  _Out_ ULONG        *MessageNumber
);

Parameters

ld [in]

The session handle.

dn [in]

A pointer to a wide, null-terminated string that contains the distinguished name of the entry to be renamed.

NewRDN [in]

A pointer to a wide, null-terminated string that contains the new relative distinguished name for the entry.

NewParent [in]

A pointer to a wide, null-terminated string that contains the 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 the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

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

Multithreading: Calls to ldap_rename_ext are thread-safe.

Requirements

See also

Extended Controls

Using Controls

Functions

Modifying a Directory Entry