1 .TH LDAP_FIRST_ENTRY 3 "23 July 2001" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldap_first_entry, ldap_next_entry, ldap_count_entries \- LDAP result entry parsing and counting routines
13 int ldap_count_entries( LDAP *ld, LDAPMessage *result )
16 LDAPMessage *ldap_first_entry( LDAP *ld, LDAPMessage *result )
19 LDAPMessage *ldap_next_entry( LDAP *ld, LDAPMessage *entry )
22 These routines are used to parse results received from
24 or the synchronous LDAP search operation routines
27 .BR ldap_search_st (3).
31 routine is used to retrieve the first entry in a chain
32 of search results. It takes the \fIresult\fP as returned by a call to
37 .BR ldap_search_st (3)
38 and returns a pointer to the first entry in the result.
40 This pointer should be supplied on a subsequent call to
42 to get the next entry, the result of which should be
43 supplied to the next call to
44 .BR ldap_next_entry() ,
47 will return NULL when there are no more entries. The entries returned
48 from these calls are used in calls to the routines described in
50 .BR ldap_first_attribute (3),
51 .BR ldap_get_values (3),
54 A count of the number of entries in the search result can be obtained
56 .BR ldap_count_entries() .
61 .BR ldap_next_entry() ,
62 NULL is returned and the ld_errno field in the \fIld\fP parameter
63 is set to indicate the error. If an error occurs in
64 .BR ldap_count_entries() ,
67 is set appropriately. See
69 for a description of possible error codes.
74 .BR ldap_first_attribute (3),
75 .BR ldap_get_values (3),
79 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
81 is derived from University of Michigan LDAP 3.3 Release.