ldap_get_values(3) [php man page]

LDAP_GET_VALUES(3)							 1							LDAP_GET_VALUES(3)

ldap_get_values - Get all values from a result entry

SYNOPSIS

       array ldap_get_values (resource	$link_identifier, resource  $result_entry_identifier, string  $attribute)

DESCRIPTION

	Reads all the values of the attribute in the entry in the result.

	This  call  needs a $result_entry_identifier, so needs to be preceded by one of the ldap search calls and one of the calls to get an indi-
       vidual entry.

	You application will either be hard coded to look for certain attributes (such as "surname" or	"mail")  or  you  will	have  to  use  the
       ldap_get_attributes(3) call to work out what attributes exist for a given entry.

PARAMETERS

	      o $link_identifier
		- An LDAP link identifier, returned by ldap_connect(3).

	      o $result_entry_identifier
		-

	      o $attribute
		-

RETURN VALUES

	Returns  an  array of values for the attribute on success and FALSE on error. The number of values can be found by indexing "count" in the
       resultant array. Individual values are accessed by integer index in the array. The first index is 0.

	LDAP allows more than one entry for an attribute, so it can, for example, store a number of email addresses  for  one  person's  directory
       entry all labeled with the attribute "mail"

	   return_value[0] = first value of attribute
	   return_value[i] = ith value of attribute

EXAMPLES

       Example #1

	      List all values of the "mail" attribute for a directory entry

	      <?php
	      // $ds is a valid link identifier for a directory server

	      // $sr is a valid search result from a prior call to
	      //     one of the ldap directory search calls

	      // $entry is a valid entry identifier from a prior call to
	      //	one of the calls that returns a directory entry

	      $values = ldap_get_values($ds, $entry, "mail");

	      echo $values["count"] . " email addresses for this entry.<br />";

	      for ($i=0; $i < $values["count"]; $i++) {
		  echo $values[$i] . "<br />";
	      }
	      ?>

SEE ALSO

       ldap_get_values_len(3).

PHP Documentation Group 													LDAP_GET_VALUES(3)

LDAP_GET_VALUES(3)					     Library Functions Manual						LDAP_GET_VALUES(3)

NAME

       ldap_get_values, ldap_get_values_len, ldap_count_values - LDAP attribute value handling routines

SYNOPSIS

       #include <ldap.h>

       typedef struct berval {
	   unsigned long bv_len;
	   char *bv_val;
       };

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

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

       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 whose values are desired and returns a NULL-terminated  array
       of  the	attribute's  values.   attr may be an attribute type as returned from ldap_first_attribute(3) or ldap_next_attribute(3), or if the
       attribute type is known it can simply be given.

       The number of values in 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 nature, and thus not suitable to be returned as an array of char *'s, the ldap_get_values_len() rou-
       tine can be used instead.  It takes the same parameters as ldap_get_values(), but returns a NULL-terminated array  of  pointers	to  berval
       structures, each containing the length of and a pointer to a value.

       The  number of values in 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 occurs in ldap_get_values() or ldap_get_values_len(), NULL is returned and the ld_errno field in the ld  parameter  is  set	to
       indicate the error.  See ldap_error(3) for a description of possible error codes.

NOTES

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

SEE ALSO

       ldap(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 2.0.27-Release 					 22 September 1998						LDAP_GET_VALUES(3)