MAN page from RedHat Other ldap-devel-3.3-3.i386.rpm

LDAP_FIRST_ENTRY

Section: C Library Functions (3)
Updated: 25 November 1994
Index

NAME

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

SYNOPSIS

#include <lber.h>#include <ldap.h>ldap_count_entries(ld, result)LDAP *ld;LDAPMessage *result;LDAPMessage *ldap_first_entry(ld, result)LDAP *ld;LDAPMessage *result;LDAPMessage *ldap_next_entry(ld, entry)LDAP *ld;LDAPMessage *entry;

DESCRIPTION

These routines are used to parse results received fromldap_result(3)or the synchronous LDAP search operation routinesldap_search_s(3)andldap_search_st(3).

Theldap_first_entry()routine is used to retrieve the first entry in a chainof search results. It takes the result as returned by a call toldap_result(3)orldap_search_s(3)orldap_search_st(3)and returns a pointer to the first entry in the result.

This pointer should be supplied on a subsequent call toldap_next_entry()to get the next entry, the result of which should besupplied to the next call toldap_next_entry(),etc.ldap_next_entry()will return NULL when there are no more entries. The entries returnedfrom these calls are used in calls to the routines described inldap_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 obtainedby callingldap_count_entries().

ERRORS

If an error occurs inldap_first_entry()orldap_next_entry(),NULL is returned and the ld_errno field in the ld parameteris set to indicate the error. If an error occurs inldap_count_entries(),-1 is returned, andld_errnois set appropriately. Seeldap_error(3)for a description of possible error codes.

This document was created byman2html,using the manual pages.