.TH LDAP_MODIFY 3 "RELEASEDATE" "OpenLDAP LDVERSION"
.\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap_modify.3,v 1.10.2.2 2004/01/01 18:16:27 kurt Exp $
.\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.SH NAME
ldap_modify, ldap_modify_s \- Perform an LDAP modify operation
.SH LIBRARY
OpenLDAP LDAP (libldap, -lldap)
.SH SYNOPSIS
.nf
.ft B
#include <ldap.h>
.LP
.ft B
.nf
int ldap_modify(ld, dn, mods)
.ft
LDAP *ld;
char *dn;
LDAPMod *mods[];
.LP
.ft B
.nf
int ldap_modify_s(ld, dn, mods)
.ft
LDAP *ld;
char *dn;
LDAPMod *mods[];
.LP
.ft B
.nf
void ldap_mods_free( mods, freemods )
.ft
LDAPMod **mods;
int freemods;
.SH DESCRIPTION
The routine
.B ldap_modify_s()
is used to perform an LDAP modify operation.
\fIdn\fP is the DN of the entry to modify, and \fImods\fP is a
null-terminated array of modifications to make to the entry. Each element
of the \fImods\fP array is a pointer to an LDAPMod structure, which is
defined below.
.LP
.nf
.ft B
typedef struct ldapmod {
int mod_op;
char *mod_type;
union {
char **modv_strvals;
struct berval **modv_bvals;
} mod_vals;
struct ldapmod *mod_next;
} LDAPMod;
#define mod_values mod_vals.modv_strvals
#define mod_bvalues mod_vals.modv_bvals
.ft
.fi
.LP
The \fImod_op\fP 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. The \fImod_type\fP and \fImod_values\fP fields
specify the attribute type to modify and a null-terminated array of
values to add, delete, or replace respectively. The \fImod_next\fP
field is used only by the LDAP server and may be ignored by the
client.
.LP
If you need to specify a non-string value (e.g., to add a
photo or audio attribute value), you should set \fImod_op\fP to the
logical OR of the operation as above (e.g., LDAP_MOD_REPLACE)
and the constant LDAP_MOD_BVALUES. In this case, \fImod_bvalues\fP
should be used instead of \fImod_values\fP, and it should point to
a null-terminated array of struct bervals, as defined in <lber.h>.
.LP
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,
the \fImod_values\fP 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.
.LP
.B
ldap_modify_s()
returns the LDAP error code resulting from the
modify operation. This code can be interpreted by
.BR ldap_perror (3)
and friends.
.LP
The
.B ldap_modify()
operation works the same way as
.BR ldap_modify_s() ,
except that it is asynchronous, returning the message id of the
request it initiates, or -1 on error. The result of the operation
can be obtained by calling
.BR ldap_result (3).
.LP
.B ldap_mods_free()
can be used to free each element of a NULL-terminated
array of mod structures. If \fIfreemods\fP is non-zero, the
\fImods\fP pointer itself is freed as well.
.SH ERRORS
.B ldap_modify_s()
returns an ldap error code, either LDAP_SUCCESS or
an error if there was trouble.
.B ldap_modify()
returns -1 in case
of trouble, setting the
.B ld_errno
field of \fIld\fP.
.SH SEE ALSO
.BR ldap (3),
.BR ldap_error (3),
.BR ldap_add (3)
.SH ACKNOWLEDGEMENTS
.B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
.B OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.