ldap_rename_ext_s function (winldap.h)

Article
02/22/2024

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

WINLDAPAPI ULONG LDAPAPI ldap_rename_ext_s(
  [in] LDAP          *ld,
  [in] const PSTR    dn,
  [in] const PSTR    NewRDN,
  [in] const PSTR    NewParent,
  [in] INT           DeleteOldRdn,
  [in] PLDAPControlA *ServerControls,
  [in] PLDAPControlA *ClientControls
);

Parameters

[in] ld

The session handle.

[in] dn

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

[in] NewRDN

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

[in] NewParent

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.

[in] DeleteOldRdn

TRUE if the old relative distinguished name should be deleted; FALSE if the old relative distinguished name should be retained.

[in] ServerControls

List of LDAP server controls.

[in] ClientControls

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

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	winldap.h
Library	Wldap32.lib
DLL	Wldap32.dll