1 .TH LDAP_FIRST_ENTRY 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_entry, ldap_next_entry, ldap_count_entries \- LDAP result entry parsing and counting routines
13 ldap_count_entries(ld, result)
19 LDAPMessage *ldap_first_entry(ld, result)
25 LDAPMessage *ldap_next_entry(ld, entry)
31 These routines are used to parse results received from
33 or the synchronous LDAP search operation routines
36 .BR ldap_search_st (3).
40 routine is used to retrieve the first entry in a chain
41 of search results. It takes the \fIresult\fP as returned by a call to
46 .BR ldap_search_st (3)
47 and returns a pointer to the first entry in the result.
49 This pointer should be supplied on a subsequent call to
51 to get the next entry, the result of which should be
52 supplied to the next call to
53 .BR ldap_next_entry() ,
56 will return NULL when there are no more entries. The entries returned
57 from these calls are used in calls to the routines described in
59 .BR ldap_first_attribute (3),
60 .BR ldap_get_values (3),
63 A count of the number of entries in the search result can be obtained
65 .BR ldap_count_entries() .
70 .BR ldap_next_entry() ,
71 NULL is returned and the ld_errno field in the \fIld\fP parameter
72 is set to indicate the error. If an error occurs in
73 .BR ldap_count_entries() ,
76 is set appropriately. See
78 for a description of possible error codes.
83 .BR ldap_first_attribute(3),
84 .BR ldap_get_values(3),
88 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
90 is derived from University of Michigan LDAP 3.3 Release.