1 .TH LDAP_FIRST_ATTRIBUTE 3 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldap_first_attribute, ldap_next_attribute \- step through LDAP entry attributes
13 char *ldap_first_attribute(
14 LDAP *ld, LDAPMessage entry, BerElement **berptr )
17 char *ldap_next_attribute(
18 LDAP *ld, LDAPMessage entry, BerElement *ber )
21 .B ldap_first_attribute()
23 .B ldap_next_attribute()
25 to step through the attributes in an LDAP entry.
26 .B ldap_first_attribute()
27 takes an \fIentry\fP as returned by
28 .BR ldap_first_entry (3)
30 .BR ldap_next_entry (3)
31 and returns a pointer to character string
32 containing the first attribute description in the entry.
33 .B ldap_next_attribute()
34 returns the next attribute description in the entry.
36 It also returns, in \fIberptr\fP, a pointer to a BerElement it has
37 allocated to keep track of its current position. This pointer should
38 be passed to subsequent calls to
39 .B ldap_next_attribute()
41 to effectively step through the entry's attributes. The caller is
42 solely responsible for freeing the BerElement pointed to by \fIberptr\fP
43 when it is no longer needed by calling
47 in this instance, be sure the second argument is 0.
49 The attribute names returned are suitable for inclusion in a call
51 .BR ldap_get_values (3)
52 to retrieve the attribute's values.
54 If an error occurs, NULL is returned and the ld_errno field in the
55 \fIld\fP parameter is set to indicate the error. See
57 for a description of possible error codes.
60 .B ldap_first_attribute()
62 .B ldap_next_attribute()
63 return dynamically allocated memory that must be freed by the caller via
67 .BR ldap_first_entry (3),
68 .BR ldap_get_values (3),
72 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
74 is derived from University of Michigan LDAP 3.3 Release.