ldap_first_entry(3ldap)

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

Synopsis

#include <lber.h> 
#include <ldap.h> 

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

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

 
ldap_count_entries(LDAP *ld, LDAPMessage *result);

Description

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

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 or ldap_search_s or ldap_search_st 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, and so on. 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(3ldap), ldap_first_attribute(3ldap), ldap_get_values(3ldap), and so on.

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

Return values

If an error occurs in ldap_first_entry or ldap_next_entry, NULL is returned. If an error occurs in ldap_count_entries, -1 is returned. See ldap_perror(3ldap) for a description of possible error codes.

See also

Intro(3ldap), ldap_first_attribute(3ldap), ldap_get_dn(3ldap), ldap_get_values(3ldap), ldap_result(3ldap), ldap_search(3ldap)
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.