ldap_parse_reference(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


LDAP_PARSE_REFERENCE(3)                                                              LDAP_PARSE_REFERENCE(3)



NAME
       ldap_parse_reference - Extract referrals and controls from a reference message

LIBRARY
       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS
       #include <ldap.h>

       int ldap_parse_reference( LDAP *ld, LDAPMessage *reference,
            char ***referralsp, LDAPControl ***serverctrlsp,
            int freeit )

DESCRIPTION
       The  ldap_parse_reference()  routine  is used to extract referrals and controls from a reference mes-sage. message.
       sage.  The reference parameter is a reference message as returned  by  a  call  to  ldap_first_refer-ence(3), ldap_first_reference(3),
       ence(3), ldap_next_reference(3), ldap_first_message(3), ldap_next_message(3), or ldap_result(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
       ldap_value_free(3).   If  referralsp  is  NULL,  no  referrals  are  returned.   If no referrals were
       returned, *referralsp is set to NULL.

       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 ldap_controls_free(3).  If serverctrlsp is NULL,
       no controls are returned.  If no controls were returned, *serverctrlsp is set to NULL.

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

ERRORS
       Upon success LDAP_SUCCESS is returned. Otherwise the values of the referralsp and serverctrlsp param-eters parameters
       eters are undefined.

SEE ALSO
       ldap(3),    ldap_first_reference(3),   ldap_first_message(3),   ldap_result(3),   ldap_get_values(3),
       ldap_controls_free(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.



OpenLDAP 2.4.11                                  2008/07/16                          LDAP_PARSE_REFERENCE(3)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation with the feedback links below.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?