GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LDAP_COUNT_ENTRIES (3)

NAME

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

CONTENTS

Library
Synopsis
Description
Errors
See Also
Acknowledgements

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.
Search for    or go to Top of page |  Section 3 |  Main Index


OpenLDAP 2.4.44 LDAP_FIRST_ENTRY (3) 2016/02/05

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.