Home | History | Annotate | Line # | Download | only in man
ldap_parse_reference.3 revision 1.7 
      1  1.5      tron .lf 1 stdin
      2  1.7  christos .TH LDAP_PARSE_REFERENCE 3 "2025/05/22" "OpenLDAP 2.6.10"
      3  1.5      tron .\" $OpenLDAP$
      4  1.7  christos .\" Copyright 1998-2024 The OpenLDAP Foundation All Rights Reserved.
      5  1.1     lukem .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
      6  1.1     lukem .SH NAME
      7  1.1     lukem ldap_parse_reference \- Extract referrals and controls from a reference message
      8  1.1     lukem .SH LIBRARY
      9  1.3     lukem OpenLDAP LDAP (libldap, \-lldap)
     10  1.1     lukem .SH SYNOPSIS
     11  1.1     lukem .nf
     12  1.1     lukem .ft B
     13  1.1     lukem #include <ldap.h>
     14  1.1     lukem .LP
     15  1.1     lukem .ft B
     16  1.1     lukem int ldap_parse_reference( LDAP *ld, LDAPMessage *reference,
     17  1.1     lukem 	char ***referralsp, LDAPControl ***serverctrlsp,
     18  1.1     lukem 	int freeit )
     19  1.1     lukem .SH DESCRIPTION
     20  1.1     lukem .LP
     21  1.1     lukem The
     22  1.1     lukem .B ldap_parse_reference()
     23  1.1     lukem routine is used to extract referrals and controls from a reference message.
     24  1.1     lukem The \fIreference\fP parameter is a reference message as returned by a
     25  1.1     lukem call to
     26  1.1     lukem .BR ldap_first_reference (3) ,
     27  1.1     lukem .BR ldap_next_reference (3) ,
     28  1.1     lukem .BR ldap_first_message (3) ,
     29  1.1     lukem .BR ldap_next_message (3) ,
     30  1.1     lukem or
     31  1.1     lukem .BR ldap_result (3) .
     32  1.1     lukem .LP
     33  1.1     lukem The \fIreferralsp\fP parameter will be filled in with an allocated array of
     34  1.1     lukem character strings. The strings are copies of the referrals contained in
     35  1.1     lukem the parsed message. The array should be freed by calling
     36  1.1     lukem .BR ldap_value_free (3) .
     37  1.1     lukem If \fIreferralsp\fP is NULL, no referrals are returned.
     38  1.1     lukem If no referrals were returned, \fI*referralsp\fP is set to NULL.
     39  1.1     lukem .LP
     40  1.1     lukem The \fIserverctrlsp\fP parameter will be filled in with an allocated array of
     41  1.1     lukem controls copied from the parsed message. The array should be freed by calling
     42  1.1     lukem .BR ldap_controls_free (3).
     43  1.1     lukem If \fIserverctrlsp\fP is NULL, no controls are returned.
     44  1.1     lukem If no controls were returned, \fI*serverctrlsp\fP is set to NULL.
     45  1.1     lukem .LP
     46  1.1     lukem The \fIfreeit\fP parameter determines whether the parsed message is
     47  1.1     lukem freed or not after the extraction. Any non-zero value will make it
     48  1.1     lukem free the message. The
     49  1.1     lukem .BR ldap_msgfree (3)
     50  1.1     lukem routine can also be used to free the message later.
     51  1.1     lukem .SH ERRORS
     52  1.1     lukem Upon success LDAP_SUCCESS is returned. Otherwise the values of the
     53  1.1     lukem \fIreferralsp\fP and \fIserverctrlsp\fP parameters are undefined.
     54  1.1     lukem .SH SEE ALSO
     55  1.1     lukem .BR ldap (3),
     56  1.1     lukem .BR ldap_first_reference (3),
     57  1.1     lukem .BR ldap_first_message (3),
     58  1.1     lukem .BR ldap_result (3),
     59  1.1     lukem .BR ldap_get_values (3),
     60  1.1     lukem .BR ldap_controls_free (3)
     61  1.1     lukem .SH ACKNOWLEDGEMENTS
     62  1.5      tron .lf 1 ./../Project
     63  1.1     lukem .\" Shared Project Acknowledgement Text
     64  1.1     lukem .B "OpenLDAP Software"
     65  1.1     lukem is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
     66  1.1     lukem .B "OpenLDAP Software"
     67  1.6  christos is derived from the University of Michigan LDAP 3.3 Release.  
     68  1.5      tron .lf 62 stdin
     69