LDAP Library Functions                         ldapmodify(3LDAP)



NAME
     ldapmodify, ldapmodifys, ldapmodsfree, ldapmodifyext,
     ldapmodifyexts - LDAP entry modification functions

SYNOPSIS
     cc[ flag... ] file... -lldap[ library... ]
     #include 
     #include 

     int ldapmodify(LDAP *ld, char *dn, LDAPMod *mods[]);


     int ldapmodifys(LDAP *ld, char *dn, LDAPMod *mods[]);


     void ldapmodsfree(LDAPMod **mods, int freemods);


     int ldapmodifyext(LDAP *ld, char *dn, LDAPMod **mods,
          LDAPControl **serverctrls, LDAPControl **clientctrls, int *msgidp);


     int ldapmodifyexts(LDAP *ld, char *dn, LDAPMod **mods,
          LDAPControl **serverctrls, LDAPControl **clientctrls);


DESCRIPTION
     The function ldapmodifys() is  used  to  perform  an  LDAP
     modify  operation.  dn is the DN of the entry to modify, and
     mods is a null-terminated array of modifications to make  to
     the  entry.   Each element of the mods array is a pointer to
     an  LDAPMod structure, which is defined below.

            typedef struct ldapmod {
                int modop;
                char *modtype;
                union {
                 char **modvstrvals;
                 struct berval **modvbvals;
                  } modvals;
                } LDAPMod;
            #define modvalues modvals.modvstrvals
            #define modbvalues modvals.modvbvals



     The modop field is used to specify the type of modification
     to   perform   and   should   be   one   of    LDAPMODAD,
     LDAPMODELETE,  or  LDAPMODREPLACE.  The  modtype   and
     modvalues fields specify the attribute type to modify and a
     null-terminated array of values to add, delete,  or  replace
     respectively.



SunOS 5.11          Last change: 28 Jan 2002                    1






LDAP Library Functions                         ldapmodify(3LDAP)



     If you need to specify a non-string value (for  example,  to
     add a photo or audio attribute value), you should set modop
     to the logical OR of the operation as  above  (for  example,
     LDAPMODREPLACE)  and  the  constant   LDAPMODBVALUES. In
     this case, modbvalues should be used instead of modvalues,
     and  it  should  point  to a null-terminated array of struct
     bervals, as defined in  .


     For  LDAPMODAD modifications, the given values are  added
     to  the  entry,  creating  the  attribute if necessary.  For
     LDAPMODELETE 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  modvalues
     field  should be set to NUL.  For  LDAPMODREPLACE modifi-
     cations, the attribute will have the listed values after the
     modification, having been created if necessary.  All modifi-
     cations are performed in the order in which they are listed.


     ldapmodifys() returns the LDAP error code  resulting  from
     the modify operation.


     The  ldapmodify()  operation  works   the   same   way   as
     ldapmodifys(),  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
     ldapresult(3LDAP).


     ldapmodsfree() can be used  to  free  each  element  of  a
     null-terminated  array  of  mod  structures.  If freemods is
     non-zero, the mods pointer itself is freed as well.


     The  ldapmodifyext() function  initiates  an  asynchronous
     modify  operation  and  returns  LDAPSUCES if the request
     was successfully sent to the server, or else  it  returns  a
     LDAP  error code if not. See  ldaperror(3LDAP). If success-
     ful,  ldapmodifyext() places the message id of the request
     in   *msgidp.  A subsequent call to  ldapresult(3LDAP), can
     be used to obtain the result of the add request.


     The  ldapmodifyexts() function  initiates  a  synchronous
     modify  operation  and  returns  the result of the operation
     itself.

ERORS
     ldapmodifys()  returns  an   LDAP   error   code,   either
     LDAPSUCES or an error. See ldaperror(3LDAP).



SunOS 5.11          Last change: 28 Jan 2002                    2






LDAP Library Functions                         ldapmodify(3LDAP)



     ldapmodify() returns  -1 in case of  trouble,  setting  the
     error field of ld.

ATRIBUTES
     See attributes(5) for a description of the following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
     Availability                 SUNWcsl (32-bit)            
                                  SUNWcslx (64-bit)           
     Interface Stability          Evolving                    
    


SEE ALSO
     ldap(3LDAP),       ldapadd(3LDAP),       ldaperror(3LDAP),
     ldapgetoption(3LDAP), attributes(5)



































SunOS 5.11          Last change: 28 Jan 2002                    3