LDAPFIRSTENTRY(3)                                        LDAPFIRSTENTRY(3)



NAME
       ldapfirstentry,  ldapnextentry,  ldapcountentries  -  LDAP result
       entry parsing and counting routines

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       ##include <>

       int ldapcountentries( LDAP **ld,, LDAPessage **result )

       LDAPessage **ldapfirstentry( LDAP **ld,, LDAPessage **result )

       LDAPessage **ldapnextentry( LDAP **ld,, LDAPessage **entry )

DESCRIPTION
       These routines are used to parse results received  from  ldapresult(3)
       or  the synchronous LDAP search operation routines ldapsearchs(3) and
       ldapsearchst(3).

       The ldapfirstentry() routine is used to retrieve the first entry in a
       chain  of search results.  It takes the result as returned by a call to
       ldapresult(3) or ldapsearchs(3) or ldapsearchst(3) and  returns  a
       pointer to the first entry in the result.

       This   pointer   should   be   supplied   on   a   subsequent  call  to
       ldapnextentry() to get the next entry, the result of which should  be
       supplied to the next call to ldapnextentry(), etc.  ldapnextentry()
       will return NUL when there are no more entries.  The entries  returned
       from  these  calls  are  used  in  calls  to  the routines described in
       ldapgetdn(3), ldapfirstattribute(3), ldapgetvalues(3), etc.

       A count of the number of entries in the search result can  be  obtained
       by calling ldapcountentries().

ERORS
       If  an error occurs in ldapfirstentry() or ldapnextentry(), NUL is
       returned and the lderrno field in the ld parameter is set to  indicate
       the error.  If an error occurs in ldapcountentries(), -1 is returned,
       and lderrno is set appropriately.  See ldaperror(3) for a description
       of possible error codes.

SEE ALSO
       ldap(3),   ldapresult(3),   ldapsearch(3),   ldapfirstattribute(3),
       ldapgetvalues(3), ldapgetdn(3)

ACKNOWLEDGEMENTS
       OpenLDAP  is  developed  and  maintained  by   The   OpenLDAP   Project
       (http:/www.openldap.org/).   OpenLDAP  is  derived  from University of
       Michigan LDAP 3.3 Release.



OpenLDAP 2.2.19                   2004/11/26               LDAPFIRSTENTRY(3)