ldap_first_attribute(3) [php man page]

LDAP_FIRST_ATTRIBUTE(3) 						 1						   LDAP_FIRST_ATTRIBUTE(3)

ldap_first_attribute - Return first attribute

SYNOPSIS

       string ldap_first_attribute (resource  $link_identifier, resource  $result_entry_identifier)

DESCRIPTION

	Gets the first attribute in the given entry. Remaining attributes are retrieved by calling ldap_next_attribute(3) successively.

	Similar to reading entries, attributes are also read one by one from a particular entry.

PARAMETERS

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

	      o $result_entry_identifier
		-

	      o $ber_identifier
		-$ber_identifier  is  the  identifier  to internal memory location pointer. It is passed by reference. The same $ber_identifier is
		passed to ldap_next_attribute(3) , which modifies that pointer.

	      Note

		      This parameter is no longer used as this is now handled automatically by PHP. For backwards compatibility PHP will not throw
		     an error if this parameter is passed.

RETURN VALUES

	Returns the first attribute in the entry on success and FALSE on error.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 5.2.4	|						    |
       |	|						    |
       |	|  The	$ber_identifier  was  removed.	This is now |
       |	| handled automatically by PHP. 		    |
       |	|						    |
       +--------+---------------------------------------------------+
SEE ALSO

       ldap_next_attribute(3), ldap_get_attributes(3).

PHP Documentation Group 												   LDAP_FIRST_ATTRIBUTE(3)

LDAP_FIRST_ATTRIBUTE(3) 				     Library Functions Manual					   LDAP_FIRST_ATTRIBUTE(3)

NAME

       ldap_first_attribute, ldap_next_attribute - step through LDAP entry attributes

LIBRARY

       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS

       #include <ldap.h>

       char *ldap_first_attribute(
	    LDAP *ld, LDAPMessage *entry, BerElement **berptr )

       char *ldap_next_attribute(
	    LDAP *ld, LDAPMessage *entry, BerElement *ber )

DESCRIPTION

       The   ldap_first_attribute()   and   ldap_next_attribute()   routines   are  used  to  step  through  the  attributes  in  an  LDAP  entry.
       ldap_first_attribute() takes an entry as returned by ldap_first_entry(3) or ldap_next_entry(3) and returns a pointer  to  character  string
       containing the first attribute description in the entry.  ldap_next_attribute() returns the next attribute description in the entry.

       It  also  returns,  in  berptr,	a  pointer to a BerElement it has allocated to keep track of its current position.  This pointer should be
       passed to subsequent calls to ldap_next_attribute() and is used to effectively step through the entry's attributes.  The caller	is  solely
       responsible  for  freeing the BerElement pointed to by berptr when it is no longer needed by calling ber_free(3).  When calling ber_free(3)
       in this instance, be sure the second argument is 0.

       The attribute names returned are suitable for inclusion in a call to ldap_get_values(3) to retrieve the attribute's values.

ERRORS

       If an error occurs, 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

       The  ldap_first_attribute()  and  ldap_next_attribute()	return dynamically allocated memory that must be freed by the caller via ldap_mem-
       free(3).

SEE ALSO

       ldap(3), ldap_first_entry(3), ldap_get_values(3), ldap_error(3)

ACKNOWLEDGEMENTS

       OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.  OpenLDAP Software is	derived  from  the
       University of Michigan LDAP 3.3 Release.

OpenLDAP							    2017/06/01						   LDAP_FIRST_ATTRIBUTE(3)