ldap_modify_s function (winldap.h)

  • Article

The ldap_modify_s function changes an existing entry.

Syntax

WINLDAPAPI ULONG LDAPAPI ldap_modify_s(
  [in] LDAP          *ld,
  [in] PSTR          dn,
  [in] LDAPModA * [] mods
);

Parameters

[in] ld

The session handle.

[in] dn

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

[in] mods

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.

Note  When connecting to an LDAP 2 server, the application must perform a bind operation (by calling one of the ldap_bind or ldap_simple_bind routines) before attempting any other operations.
 

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

See also

Functions

LDAP

LDAPMod

Modifying a Directory Entry

Return Values

ldap_bind

ldap_modify

ldap_modify_ext

ldap_modify_ext_s

ldap_simple_bind