Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

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_resultfunction 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_RETCODEenumeration 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

Header winldap.h
Library wldap32.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also