Seth Woolley's Man Viewer

ldap_get_values(3) - ldap_count_values, ldap_get_values, ldap_get_values_len - LDAP attribute value handling routines - man 3 ldap_get_values

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

LDAP_GET_VALUES(3)                                          LDAP_GET_VALUES(3)



NAME
       ldap_get_values,    ldap_get_values_len,   ldap_count_values   -   LDAP
       attribute value handling routines

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #include <ldap.h>


       char **ldap_get_values(ld(1,8), entry, attr(1,5))
       LDAP *ld(1,8);
       LDAPMessage *entry;
       char *attr(1,5)

       struct berval **ldap_get_values_len(ld(1,8), entry, attr(1,5))
       LDAP *ld(1,8);
       LDAPMessage *entry;
       char *attr(1,5)

       ldap_count_values(vals)
       char **vals;

       ldap_count_values_len(vals)
       struct berval **vals;

       ldap_value_free(vals)
       char **vals;

       ldap_value_free_len(vals)
       struct berval **vals;

DESCRIPTION
       These routines are used to retrieve  and  manipulate  attribute  values
       from   an   LDAP   entry   as   returned   by   ldap_first_entry(3)  or
       ldap_next_entry(3).   ldap_get_values()  takes  the   entry   and   the
       attribute  attr(1,5)  whose values are desired and returns a NULL-terminated
       array of the attribute's values.  attr(1,5) may  be  an  attribute  type  as
       returned  from ldap_first_attribute(3) or ldap_next_attribute(3), or if(3,n)
       the attribute type is known it can simply be given.

       The  number  of  values  in(1,8)  the  array  can  be  counted  by   calling
       ldap_count_values().   The  array  of  values  returned can be freed by
       calling ldap_value_free().

       If the attribute values are binary in(1,8) nature, and thus not suitable  to
       be  returned as an array of char *'s, the ldap_get_values_len() routine
       can be used instead.  It takes the  same  parameters  as  ldap_get_val-
       ues(), but returns a NULL-terminated array of pointers to berval struc-
       tures, each containing the length of and a pointer to a value.

       The  number  of  values  in(1,8)  the  array  can  be  counted  by   calling
       ldap_count_values_len().   The array of values returned can be freed by
       calling ldap_value_free_len().

ERRORS
       If an error(8,n) occurs in(1,8) ldap_get_values() or ldap_get_values_len(),  NULL
       is  returned and the ld_errno field in(1,8) the ld(1,8) parameter is set(7,n,1 builtins) to indi-
       cate the error.  See ldap_error(3) for a description of possible  error(8,n)
       codes.

NOTES
       These  routines  dynamically allocate memory which the caller must free
       using the supplied routines.

SEE ALSO
       ldap(3,5,n)(3), ldap_first_entry(3), ldap_first_attribute(3), ldap_error(3)

ACKNOWLEDGEMENTS
       OpenLDAP  is  developed  and  maintained  by   The   OpenLDAP   Project
       (http://www.openldap.org/).   OpenLDAP  is  derived  from University of
       Michigan LDAP 3.3 Release.



OpenLDAP LDVERSION                RELEASEDATE               LDAP_GET_VALUES(3)

References for this manual (incoming links)