ldap_modify_s function

The ldap_modify_s function changes an existing entry.

Syntax

ULONG ldap_modify_s(
  _In_ LDAP    *ld,
  _In_ PCHAR   dn,
  _In_ LDAPMod *mods[]
);

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.

Return value

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_s function initiates a synchronous operation to modify an existing entry. If values are being added to or replaced in the entry, the function creates the attribute, if necessary. If values are being deleted, the function removes the attribute if no values remain. All modifications are performed in the order in which they are listed.

Multithreading: Calls to ldap_modify_s are thread-safe.

Requirements

See also

Functions

LDAP

LDAPMod

ldap_bind

ldap_simple_bind

ldap_modify

ldap_modify_ext

ldap_modify_ext_s

Modifying a Directory Entry

Return Values