MAN page from Mandrake Other ldap-devel-3.3-3.i386.rpm

LDAP_MODIFY

Section: C Library Functions (3)
Updated: 15 November 1994
Index

NAME

ldap_modify, ldap_modify_s - Perform an LDAP modify operation

SYNOPSIS

#include <lber.h>#include <ldap.h>int ldap_modify(ld, dn, mods)LDAP *ld;char *dn;LDAPMod *mods[];int ldap_modify_s(ld, dn, mods)LDAP *ld;char *dn;LDAPMod *mods[];void ldap_mods_free( mods, freemods )LDAPMod **mods;int freemods;

DESCRIPTION

The routineldap_modify_s()is used to perform an LDAP modify operation.dn is the DN of the entry to modify, and mods is anull-terminated array of modifications to make to the entry. Each elementof the mods array is a pointer to an LDAPMod structure, which isdefined below.

        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

The mod_op field is used to specify the type of modification toperform and should be one of LDAP_MOD_ADD, LDAP_MOD_DELETE, orLDAP_MOD_REPLACE. The mod_type and mod_values fieldsspecify the attribute type to modify and a null-terminated array ofvalues to add, delete, or replace respectively. The mod_nextfield is used only by the LDAP server and may be ignored by theclient.

If you need to specify a non-string value (e.g., to add aphoto or audio attribute value), you should set mod_op to thelogical OR of the operation as above (e.g., LDAP_MOD_REPLACE)and the constant LDAP_MOD_BVALUES. In this case, mod_bvaluesshould be used instead of mod_values, and it should point toa null-terminated array of struct bervals, as defined in <lber.h>.

For LDAP_MOD_ADD modifications, the given values are added to theentry, creating the attribute if necessary. For LDAP_MOD_DELETEmodifications, the given values are deleted from the entry, removingthe attribute if no values remain. If the entire attribute is to be deleted,the mod_values field should be set to NULL. For LDAP_MOD_REPLACEmodifications, the attribute will have the listed values after themodification, having been created if necessary. All modifications areperformed in the order in which they are listed.

ldap_modify_s()returns the LDAP error code resulting from themodify operation. This code can be interpreted byldap_perror(3)and friends.

Theldap_modify()operation works the same way asldap_modify_s(),except that it is asynchronous, returning the message id of therequest it initiates, or -1 on error. The result of the operationcan be obtained by callingldap_result(3).

ldap_mods_free()can be used to free each element of a NULL-terminatedarray of mod structures. If freemods is non-zero, themods pointer itself is freed as well.

ERRORS

ldap_modify_s()returns an ldap error code, either LDAP_SUCCESS oran error if there was trouble.ldap_modify()returns -1 in caseof trouble, setting theld_errnofield of ld.

This document was created byman2html,using the manual pages.