LDAPFIRSTREFERENCE(3) LDAPFIRSTREFERENCE(3)

NAME
       ldapfirstreference,   ldapnextreference,   ldapcountreferences  -
       Stepping through continuation references in a result chain

LLIIBBRRAARRYY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       ##iinncclluuddee <>

       iinntt llddaappccoouunnttrreeffeerreenncceess(( LLDDAAPP **lldd,, LLDDAAPPMMeessssaaggee **rreessuulltt ))

       LLDDAAPPMMeessssaaggee **llddaappffiirrssttrreeffeerreennccee(( LLDDAAPP **lldd,, LLDDAAPPMMeessssaaggee **rreessuulltt ))

       LLDDAAPPMMeessssaaggee **llddaappnneexxttrreeffeerreennccee(( LLDDAAPP **lldd,, LLDDAAPPMMeessssaaggee **rreeffeerreennccee ))

DESCRIPTION
       These routines are used to step through the continuation references  in
       a  result  chain  received  from llddaapprreessuulltt(3) or the synchronous LDAP
       search operation routines.

       The llddaappffiirrssttrreeffeerreennccee(()) routine is used to retrieve the first refer-
       ence  message  in a result chain.  It takes the result as returned by a
       call  to  llddaapprreessuulltt(3),,  llddaappsseeaarrcchhss(3)  or  llddaappsseeaarrcchhsstt(3)  and
       returns a pointer to the first reference message in the result chain.

       This  pointer should be supplied on a subsequent call to llddaappnneexxttrreeff-
       eerreennccee(()) to get the next reference message, the result of which  should
       be   supplied   to   the   next  call  to  llddaappnneexxttrreeffeerreennccee(()),  etc.
       llddaappnneexxttrreeffeerreennccee(()) will return NULL when there are no more reference
       messages.  The reference messages returned from these calls are used by
       llddaappppaarrsseerreeffeerreennccee(3) to extract referrals and controls.

       A count of the number of reference messages in the search result can be
       obtained  by  calling  llddaappccoouunnttrreeffeerreenncceess(()).  It can also be used to
       count the number of reference messages remaining in a result chain.

EERRRROORRSS
       If an error occurs in llddaappffiirrssttrreeffeerreennccee(()) or  llddaappnneexxttrreeffeerreennccee(()),
       NULL is returned.  If an error occurs in llddaappccoouunnttrreeffeerreenncceess(()), -1 is
       returned.

SEE ALSO
       llddaapp(3), llddaapprreessuulltt(3), llddaappsseeaarrcchh(3), llddaappppaarrsseerreeffeerreennccee(3)

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



OpenLDAP 2.2.19                   2004/11/26           LDAPFIRSTREFERENCE(3)