ldap_first_entry(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


LDAP_FIRST_ENTRY(3)                                                                      LDAP_FIRST_ENTRY(3)



NAME
       ldap_first_entry,  ldap_next_entry,  ldap_count_entries - LDAP result entry parsing and counting rou-tines routines
       tines

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #include <ldap.h>

       int ldap_count_entries( LDAP *ld, LDAPMessage *result )

       LDAPMessage *ldap_first_entry( LDAP *ld, LDAPMessage *result )

       LDAPMessage *ldap_next_entry( LDAP *ld, LDAPMessage *entry )

DESCRIPTION
       These routines are used to parse results received from ldap_result(3) or the synchronous LDAP  search
       operation routines ldap_search_s(3) and ldap_search_st(3).

       The  ldap_first_entry() routine is used to retrieve the first entry in a chain of search results.  It
       takes the result as returned by a call to ldap_result(3) or ldap_search_s(3) or ldap_search_st(3) and
       returns a pointer to the first entry in the result.

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

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

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

SEE ALSO
       ldap(3), ldap_result(3), ldap_search(3), ldap_first_attribute(3), ldap_get_values(3), ldap_get_dn(3)

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



OpenLDAP 2.4.11                                  2008/07/16                              LDAP_FIRST_ENTRY(3)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation with the feedback links below.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?