ldap_modify_ext

The ldap_modify_ext function changes an existing entry.

ULONG ldap_modify_ext(
  LDAP* ld,
  PCHAR dn,
  LDAPMod* mods[],
  PLDAPControl* ServerControls,
  PLDAPControl* ClientControls,
  ULONG* MessageNumber
);

Parameters

ld

[in] The session handle.

dn

[in] A pointer to a null-terminated string that contains the name of the entry to modify.

mods

[in] A null-terminated array of modifications to make to the entry.

ServerControls

[in] A list of LDAP server controls.

ClientControls

[in] A list of client controls

MessageNumber

[out] This result parameter is set to the message ID of the request if the call succeeds.

Return Values

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

The ldap_modify_ext function initiates an asynchronous operation to modify an existing entry. If values are being added or replaced in the entry, the function creates the attribute, if necessary. If values are being deleted, and no values remain, the function removes the attribute. All modifications are performed in the order in which they are listed.

The parameters and effects of ldap_modify_ext subsume those of ldap_modify. The extended routine includes additional parameters to support client and server controls, and thread safety.

If successful, ldap_modify_ext passes back the message ID for the operation in the MessageNumber parameter. Call ldap_result with the message ID to obtain the result of the operation. If you prefer to have the function return the result directly, use the synchronous extended function ldap_modify_ext_s.

Multithreading: Calls to ldap_modify_ext are thread-safe.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Unicode: Implemented as Unicode and ANSI versions on all platforms.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Extended Controls, Using Controls, Functions, LDAP, LDAPMod, ldap_modify, ldap_modify_ext_s, ldap_result, Modifying a Directory Entry, Return Values