1 .TH LDAP_FIRST_ATTRIBUTE 3 "22 September 1998" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2000 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(ld, entry, berptr)
20 char *ldap_next_attribute(ld, entry, ber)
27 .B ldap_first_attribute()
29 .B ldap_next_attribute()
31 to step through the attributes in an LDAP entry.
32 .B ldap_first_attribute()
33 takes an \fIentry\fP as returned by
34 .BR ldap_first_entry (3)
36 .BR ldap_next_entry (3)
37 and returns a pointer to a per-connection buffer
38 containing the first attribute type in the entry. The return value
39 should be treated as if it is a pointer to a static area (i.e.,
41 it if you want to save it).
43 It also returns, in \fIberptr\fP, a pointer to a BerElement it has
44 allocated to keep track of its current position. This pointer should
45 be passed to subsequent calls to
46 .B ldap_next_attribute()
48 to effectively step through the entry's attributes. The caller is
49 solely responsible for freeing the BerElement pointed to by \fIberptr\fP
50 when it is no longer needed by calling
54 in this instance, be sure the second argument is 0.
56 The attribute names returned are suitable for inclusion in a call
58 .BR ldap_get_values (3)
59 to retrieve the attribute's values.
61 If an error occurs, NULL is returned and the ld_errno field in the
62 \fIld\fP parameter is set to indicate the error. See
64 for a description of possible error codes.
67 .B ldap_first_attribute()
68 routine dyanamically allocated memory that must be freed by the caller via
72 .BR ldap_first_entry(3),
73 .BR ldap_get_values(3),
77 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
79 is derived from University of Michigan LDAP 3.3 Release.