Skip to content

Latest commit

 

History

History
141 lines (89 loc) · 4.99 KB

nf-winldap-ldap_modify.md

File metadata and controls

141 lines (89 loc) · 4.99 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winldap.ldap_modify
ldap_modify function (winldap.h)
The ldap_modify function (winldap.h) initiates an asynchronous operation to modify an existing entry.
_ldap_ldap_modify
ldap.ldap__modify
ldap.ldap_modify
ldap_modify
ldap_modify function [LDAP]
ldap_modifyA
ldap_modifyW
winldap/ldap_modify
winldap/ldap_modifyA
winldap/ldap_modifyW
ldap\ldap_modify.htm
ldap
93ae0af4-1b16-4bb0-952f-139241189d79
08/03/2022
_ldap_ldap_modify, ldap.ldap__modify, ldap.ldap_modify, ldap_modify, ldap_modify function [LDAP], ldap_modifyA, ldap_modifyW, winldap/ldap_modify, winldap/ldap_modifyA, winldap/ldap_modifyW
winldap.h
Windows
Windows Vista
Windows Server 2008
ldap_modifyW (Unicode) and ldap_modifyA (ANSI)
Wldap32.lib
Wldap32.dll
Windows
19H1
ldap_modify
winldap/ldap_modify
c++
APIRef
kbSyntax
DllExport
Wldap32.dll
ldap_modify
ldap_modifyA
ldap_modifyW

ldap_modify function

-description

The ldap_modify function changes an existing entry.

-parameters

-param ld [in]

The session handle.

-param dn [in]

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

-param mods [in]

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

-returns

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  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.
 

-see-also

Functions

LDAP

LDAPMod

Modifying a Directory Entry

ldap_abandon

ldap_bind

ldap_modify_ext

ldap_modify_ext_s

ldap_modify_s

ldap_result

ldap_simple_bind