ldap_modifyW function (winldap.h)
The ldap_modify function changes an existing entry.
Syntax
WINLDAPAPI ULONG LDAPAPI ldap_modifyW(
[in] LDAP *ld,
[in] PWSTR dn,
[in] LDAPModW * [] 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, 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
The ldap_modify function initiates an asynchronous 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, and no values remain, the function removes the attribute. All modifications are performed in the order in which they are listed.
As an asynchronous function, ldap_modify 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 operation before it has completed, call ldap_abandon.
If you prefer to have the function return the results directly, use the synchronous routine ldap_modify_s. Use ldap_modify_ext or ldap_modify_ext_s if you need support for LDAP 3 server and client controls.
Multithreading: Calls to ldap_modify are thread-safe, provided that LdapGetLastError is used to retrieve the actual session error code when the function call returns the -1 failure code.
Note
The winldap.h header defines ldap_modify as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
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 |