Share via

ldap_rename_ext_s (Compact 2013)

  • Article

3/26/2014

This function is a synchronous 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_s(
  LDAP* ld,
  UNICODE PTCHAR dn,
  UNICODE PTCHAR NewRDN,
  UNICODE PTCHAR NewParent,
  INT DeleteOldRdn,
  LDAPControl** ServerControls,
  LDAPControl** ClientControls
);

Parameters

  • ld
    [in] Session handle.
  • dn
    [in] Distinguished name of the entry to be renamed.
  • NewRDN
    [in] New relative distinguished name.
  • 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.

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

In a multithreading environment, calls tothis functionare thread-safe.

Requirements

Header

winldap.h

Library

wldap32.lib

See Also

Reference

LDAP Directory Entry Functions
LDAP_RETCODE