HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. |  |
NAME |LIBRARY |SYNOPSIS |DESCRIPTION |DEPRECATED INTERFACES |SEE ALSO |ACKNOWLEDGEMENTS |COLOPHON | |
LDAP_MODIFY(3) Library Functions ManualLDAP_MODIFY(3)ldap_modify_ext, ldap_modify_ext_s - Perform an LDAP modify operation
OpenLDAP LDAP (libldap, -lldap)
#include <ldap.h>int ldap_modify_ext(LDAP *ld,char *dn,LDAPMod *mods[],LDAPControl **sctrls,LDAPControl **cctrls,int *msgidp);int ldap_modify_ext_s(LDAP *ld,char *dn,LDAPMod *mods[],LDAPControl **sctrls,LDAPControl **cctrls);void ldap_mods_free(LDAPMod **mods,intfreemods);
The routineldap_modify_ext_s()is used to perform an LDAP modify operation.dn is the DN of the entry to modify, andmods is a null-terminated array of modifications to make to the entry. Each element of themods array is a pointer to an LDAPMod structure, which is defined below. typedef struct ldapmod { int mod_op; char *mod_type; union { char **modv_strvals; struct berval **modv_bvals; } mod_vals; } LDAPMod; #define mod_values mod_vals.modv_strvals #define mod_bvalues mod_vals.modv_bvals Themod_op field is used to specify the type of modification to perform and should be one of LDAP_MOD_ADD, LDAP_MOD_DELETE, or LDAP_MOD_REPLACE. Themod_type andmod_values fields specify the attribute type to modify and a null-terminated array of values to add, delete, or replace respectively. If you need to specify a non-string value (e.g., to add a photo or audio attribute value), you should setmod_op to the logical OR of the operation as above (e.g., LDAP_MOD_REPLACE) and the constant LDAP_MOD_BVALUES. In this case,mod_bvalues should be used instead ofmod_values, and it should point to a null-terminated array of struct bervals, as defined in <lber.h>. For LDAP_MOD_ADD modifications, the given values are added to the entry, creating the attribute if necessary. For LDAP_MOD_DELETE modifications, the given values are deleted from the entry, removing the attribute if no values remain. If the entire attribute is to be deleted, themod_values field should be set to NULL. For LDAP_MOD_REPLACE modifications, the attribute will have the listed values after the modification, having been created if necessary. All modifications are performed in the order in which they are listed.ldap_mods_free()can be used to free each element of a NULL- terminated array of mod structures. Iffreemods is non-zero, themods pointer itself is freed as well.ldap_modify_ext_s()returns a code indicating success or, in the case of failure, indicating the nature of the failure. Seeldap_error(3) for details Theldap_modify_ext()operation works the same way asldap_modify_ext_s(), except that it is asynchronous. The integer thatmsgidp points to is set to the message id of the modify request. The result of the operation can be obtained by callingldap_result(3). Bothldap_modify_ext()andldap_modify_ext_s()allows server and client controls to be passed in via the sctrls and cctrls parameters, respectively.Theldap_modify()andldap_modify_s()routines are deprecated in favor of theldap_modify_ext()andldap_modify_ext_s()routines, respectively. Deprecated interfaces generally remain in the library. The macro LDAP_DEPRECATED can be defined to a non-zero value (e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use deprecated interfaces. It is recommended that developers writing new programs, or updating old programs, avoid use of deprecated interfaces. Over time, it is expected that documentation (and, eventually, support) for deprecated interfaces to be eliminated.
ldap(3),ldap_error(3),
OpenLDAP Softwareis developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.OpenLDAP Softwareis derived from the University of Michigan LDAP 3.3 Release.
This page is part of theOpenLDAP (an open source implementation of the Lightweight Directory Access Protocol) project. Information about the project can be found at ⟨http://www.openldap.org/⟩. If you have a bug report for this manual page, see ⟨http://www.openldap.org/its/⟩. This page was obtained from the project's upstream Git repository ⟨https://git.openldap.org/openldap/openldap.git⟩ on 2025-08-11. (At that time, the date of the most recent commit that was found in the repository was 2025-08-05.) If you discover any rendering problems in this HTML version of the page, or you believe there is a better or more up-to-date source for the page, or you have corrections or improvements to the information in this COLOPHON (which isnot part of the original manual page), send a mail to man-pages@man7.orgOpenLDAP LDVERSION RELEASEDATELDAP_MODIFY(3)Pages that refer to this page:ldapmodify(1), ldap_add(3), ldap_get_option(3), ldap_rename(3), ldap_result(3)
HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH. | |