1LDAP_FIRST_ENTRY(3)        Library Functions Manual        LDAP_FIRST_ENTRY(3)
2
3
4

NAME

6       ldap_first_entry,  ldap_next_entry,  ldap_count_entries  -  LDAP result
7       entry parsing and counting routines
8

LIBRARY

10       OpenLDAP LDAP (libldap, -lldap)
11

SYNOPSIS

13       #include <ldap.h>
14
15       int ldap_count_entries( LDAP *ld, LDAPMessage *result )
16
17       LDAPMessage *ldap_first_entry( LDAP *ld, LDAPMessage *result )
18
19       LDAPMessage *ldap_next_entry( LDAP *ld, LDAPMessage *entry )
20

DESCRIPTION

22       These routines are used to parse results received  from  ldap_result(3)
23       or  the synchronous LDAP search operation routines ldap_search_s(3) and
24       ldap_search_st(3).
25
26       The ldap_first_entry() routine is used to retrieve the first entry in a
27       chain  of search results.  It takes the result as returned by a call to
28       ldap_result(3) or ldap_search_s(3) or ldap_search_st(3) and  returns  a
29       pointer to the first entry in the result.
30
31       This   pointer   should   be   supplied   on   a   subsequent  call  to
32       ldap_next_entry() to get the next entry, the result of which should  be
33       supplied to the next call to ldap_next_entry(), etc.  ldap_next_entry()
34       will return NULL when there are no more entries.  The entries  returned
35       from  these  calls  are  used  in  calls  to  the routines described in
36       ldap_get_dn(3), ldap_first_attribute(3), ldap_get_values(3), etc.
37
38       A count of the number of entries in the search result can  be  obtained
39       by calling ldap_count_entries().
40

ERRORS

42       If  an error occurs in ldap_first_entry() or ldap_next_entry(), NULL is
43       returned and the ld_errno field in the ld parameter is set to  indicate
44       the error.  If an error occurs in ldap_count_entries(), -1 is returned,
45       and ld_errno is set appropriately.  See ldap_error(3) for a description
46       of possible error codes.
47

SEE ALSO

49       ldap(3),   ldap_result(3),   ldap_search(3),   ldap_first_attribute(3),
50       ldap_get_values(3), ldap_get_dn(3)
51

ACKNOWLEDGEMENTS

53       OpenLDAP Software is developed and maintained by The  OpenLDAP  Project
54       <http://www.openldap.org/>.   OpenLDAP Software is derived from Univer‐
55       sity of Michigan LDAP 3.3 Release.
56
57
58
59OpenLDAP 2.4.23                   2010/06/30               LDAP_FIRST_ENTRY(3)
Impressum