ldap_rename_ext_s function

The ldap_rename_ext_s function is a synchronous 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_s(
  _In_ LDAP         *ld,
  _In_ PWCHAR       dn,
  _In_ PWCHAR       NewRDN,
  _In_ PWCHAR       NewParent,
  _In_ INT          DeleteOldRdn,
  _In_ PLDAPControl *ServerControls,
  _In_ PLDAPControl *ClientControls
);

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.

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.

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

Multithreading: Calls to ldap_rename_ext_s are thread-safe.

Requirements

See also

Extended Controls

Using Controls

Functions

Modifying a Directory Entry