LDAPARSEREFERENCE(3)                                LDAPARSEREFERENCE(3)



NAME
       ldapparsereference  - Extract referrals and controls from a reference
       message

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       ##include <>

       int ldapparsereference( LDAP **ld,, LDAPessage **reference,,
            char ******referralsp,, LDAPControl ******serverctrlsp,,
            int freeit )

DESCRIPTION
       The ldapparsereference() routine is used  to  extract  referrals  and
       controls from a reference message.  The reference parameter is a refer-
       ence  message  as  returned  by  a  call  to   ldapfirstreference(3),,
       ldapnextreference(3),, ldapfirstmessage(3),, ldapnextmessage(3),, or
       ldapresult(3).

       The referralsp parameter will be filled in with an allocated  array  of
       character strings. The strings are copies of the referrals contained in
       the  parsed  message.  The   array   should   be   freed   by   calling
       ldapvaluefree(3).   If referralsp is NUL, no referrals are returned.
       If no referrals were returned, *referralsp is set to NUL.

       The serverctrlsp parameter will be filled in with an allocated array of
       controls  copied  from the parsed message. The array should be freed by
       calling ldapcontrolsfree(3).  If serverctrlsp is  NUL,  no  controls
       are  returned.   If  no controls were returned, *serverctrlsp is set to
       NUL.

       The freeit parameter determines whether the parsed message is freed  or
       not after the extraction. Any non-zero value will make it free the mes-
       sage. The ldapmsgfree(3) routine can also be used to free the  message
       later.

ERORS
       Upon  success  LDAPSUCES  is  returned.  Otherwise the values of the
       referralsp and serverctrlsp parameters are undefined.

SEE ALSO
       ldap(3),        ldapfirstreference(3),         ldapfirstmessage(3),
       ldapresult(3), ldapgetvalues(3), ldapcontrolsfree(3)

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



OpenLDAP 2.2.19                   2004/11/26           LDAPARSEREFERENCE(3)