ldap_modify_ext (Compact 2013)

3/26/2014

This function changes an existing entry.

Syntax

ULONG ldap_modify_ext(
  LDAP* ld,
  UNICODE PTCHAR dn,
  LDAPMod* mods[],
  LDAPControl** ServerControls,
  LDAPControl** ClientControls,
  ULONG* MessageNumber
);

Parameters

• ld
  [in] Session handle.

• dn
  [in] Name of the entry to modify.

• mods
  [in] Null-terminated array of modifications to make to the entry.

• ServerControls
  [in] List of LDAP server controls.

• ClientControls
  [in] List of client controls

• MessageNumber
  [out] Result parameter set to the message identifier of the request if the call succeeds.

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

This 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 this function include those of ldap_modify. The extended routine includes additional parameters to support client and server controls and thread-safety.

If successful, this function passes back the message identifier for the operation in the MessageNumber parameter. Call ldap_result with the message identifier 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.

In a multithreading environment, calls to ldap_modify_ext are thread-safe.

Requirements

See Also

Reference

LDAP Directory Entry Functions
LDAP_RETCODE
ldap_modify
ldap_modify_ext_s
ldap_result