ldap_modrdn function (winldap.h)
The ldap_modrdn function changes the relative distinguished name of an LDAP entry.
This function is obsolete and is provided for backward compatibility with earlier versions of LDAP. For LDAP 3 or later, use the ldap_rename_ext or ldap_rename_ext_s functions.
Syntax
WINLDAPAPI ULONG LDAPAPI ldap_modrdn(
[in] LDAP *ExternalHandle,
[in] const PSTR DistinguishedName,
[out] const PSTR NewDistinguishedName
);
Parameters
[in] ExternalHandle
The session handle.
[in] DistinguishedName
A pointer to a null-terminated string that contains the distinguished name of the entry to be changed.
[out] NewDistinguishedName
A pointer to a null-terminated string that contains the new relative distinguished name to give the entry.
Return value
If the function succeeds, it returns the message ID of the modify operation.
If the function fails, it returns –1 and sets the session error parameters in the LDAP data structure.
Remarks
Use the ldap_modrdn function, or its synchronous equivalent, ldap_modrdn_s, to change the name of an LDAP entry. LDAP 2 supports additional features through ldap_modrdn2 and ldap_modrdn2_s.
As an asynchronous function, ldap_modrdn returns a message ID for the operation. Call ldap_result with the message ID to get the result of the operation. To cancel an asynchronous add operation before it has completed, call ldap_abandon.
Be aware that the various ldap_modrdn functions allow you to change only the relative distinguished name, which is the least significant component of the object's distinguished name. Effective with version 3, LDAP provides the Modify Distinguished Name protocol operation that allows more general name change access. This feature is available by calling ldap_rename_ext or ldap_rename_ext_s. These functions are recommended, instead of the ldap_modrdn function, to change an entry name.
Multithreading: Calls to ldap_modrdn are thread-safe, provided that LdapGetLastError is used to retrieve the actual session error code when the function call returns the -1 failure code.
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 |