2002-06-12 23:59:10 -04:00
|
|
|
.TH LDAP_FIRST_ATTRIBUTE 3 "RELEASEDATE" "OpenLDAP LDVERSION"
|
1999-09-12 00:41:47 -04:00
|
|
|
.\" $OpenLDAP$
|
2007-01-02 15:00:42 -05:00
|
|
|
.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
|
1999-09-12 00:41:47 -04:00
|
|
|
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
1998-08-08 20:43:13 -04:00
|
|
|
.SH NAME
|
|
|
|
|
ldap_first_attribute, ldap_next_attribute \- step through LDAP entry attributes
|
2002-06-21 03:32:54 -04:00
|
|
|
.SH LIBRARY
|
2002-06-21 17:25:38 -04:00
|
|
|
OpenLDAP LDAP (libldap, -lldap)
|
1998-08-08 20:43:13 -04:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
.ft B
|
|
|
|
|
#include <ldap.h>
|
|
|
|
|
.LP
|
|
|
|
|
.ft B
|
2001-07-24 03:56:07 -04:00
|
|
|
char *ldap_first_attribute(
|
2005-05-12 22:55:21 -04:00
|
|
|
LDAP *ld, LDAPMessage *entry, BerElement **berptr )
|
1998-08-08 20:43:13 -04:00
|
|
|
.LP
|
|
|
|
|
.ft B
|
2001-07-24 03:56:07 -04:00
|
|
|
char *ldap_next_attribute(
|
2005-05-12 22:55:21 -04:00
|
|
|
LDAP *ld, LDAPMessage *entry, BerElement *ber )
|
1998-08-08 20:43:13 -04:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.B ldap_first_attribute()
|
|
|
|
|
and
|
|
|
|
|
.B ldap_next_attribute()
|
|
|
|
|
routines are used
|
|
|
|
|
to step through the attributes in an LDAP entry.
|
|
|
|
|
.B ldap_first_attribute()
|
|
|
|
|
takes an \fIentry\fP as returned by
|
|
|
|
|
.BR ldap_first_entry (3)
|
|
|
|
|
or
|
|
|
|
|
.BR ldap_next_entry (3)
|
2000-10-04 16:40:49 -04:00
|
|
|
and returns a pointer to character string
|
|
|
|
|
containing the first attribute description in the entry.
|
|
|
|
|
.B ldap_next_attribute()
|
|
|
|
|
returns the next attribute description in the entry.
|
1998-08-08 20:43:13 -04:00
|
|
|
.LP
|
|
|
|
|
It also returns, in \fIberptr\fP, a pointer to a BerElement it has
|
|
|
|
|
allocated to keep track of its current position. This pointer should
|
|
|
|
|
be passed to subsequent calls to
|
|
|
|
|
.B ldap_next_attribute()
|
2006-10-07 09:11:53 -04:00
|
|
|
and is used
|
1999-01-20 15:21:38 -05:00
|
|
|
to effectively step through the entry's attributes. The caller is
|
|
|
|
|
solely responsible for freeing the BerElement pointed to by \fIberptr\fP
|
|
|
|
|
when it is no longer needed by calling
|
1998-08-08 20:43:13 -04:00
|
|
|
.BR ber_free (3).
|
|
|
|
|
When calling
|
|
|
|
|
.BR ber_free (3)
|
|
|
|
|
in this instance, be sure the second argument is 0.
|
|
|
|
|
.LP
|
|
|
|
|
The attribute names returned are suitable for inclusion in a call
|
|
|
|
|
to
|
|
|
|
|
.BR ldap_get_values (3)
|
|
|
|
|
to retrieve the attribute's values.
|
|
|
|
|
.SH ERRORS
|
|
|
|
|
If an error occurs, NULL is returned and the ld_errno field in the
|
|
|
|
|
\fIld\fP parameter is set to indicate the error. See
|
|
|
|
|
.BR ldap_error (3)
|
|
|
|
|
for a description of possible error codes.
|
|
|
|
|
.SH NOTES
|
|
|
|
|
The
|
|
|
|
|
.B ldap_first_attribute()
|
2001-07-24 03:56:07 -04:00
|
|
|
and
|
|
|
|
|
.B ldap_next_attribute()
|
2001-07-29 07:46:41 -04:00
|
|
|
return dynamically allocated memory that must be freed by the caller via
|
2000-10-04 16:40:49 -04:00
|
|
|
.BR ldap_memfree (3).
|
1998-08-08 20:43:13 -04:00
|
|
|
.SH SEE ALSO
|
2002-05-08 22:07:41 -04:00
|
|
|
.BR ldap (3),
|
|
|
|
|
.BR ldap_first_entry (3),
|
|
|
|
|
.BR ldap_get_values (3),
|
|
|
|
|
.BR ldap_error (3)
|
1998-10-24 21:41:42 -04:00
|
|
|
.SH ACKNOWLEDGEMENTS
|
2007-01-02 15:25:16 -05:00
|
|
|
.so ../Project
|
