]> git.sur5r.net Git - openldap/blobdiff - doc/man/man3/ldap_parse_reference.3
s/local socket/IPC/
[openldap] / doc / man / man3 / ldap_parse_reference.3
index b5cd8241dd55c91f34d9be62f90b73f32984b960..cff502a3634692151242a855f48b743b5eafd179 100644 (file)
@@ -1,9 +1,11 @@
-.TH LDAP_PARSE_REFERENCE 3 "26 September 2001" "OpenLDAP LDVERSION"
+.TH LDAP_PARSE_REFERENCE 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2001 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
-ldap_parse \- Extract referrals and controls from a reference message
+ldap_parse_reference \- Extract referrals and controls from a reference message
+.SH LIBRARY
+OpenLDAP LDAP (libldap, -lldap)
 .SH SYNOPSIS
 .nf
 .ft B
@@ -11,7 +13,8 @@ ldap_parse \- Extract referrals and controls from a reference message
 .LP
 .ft B
 int ldap_parse_reference( LDAP *ld, LDAPMessage *reference,
-       char ***referralsp, LDAPControl ***serverctrlsp, int freeit )
+       char ***referralsp, LDAPControl ***serverctrlsp,
+       int freeit )
 .SH DESCRIPTION
 .LP
 The
@@ -22,7 +25,7 @@ call to
 .BR ldap_first_reference (3) ,
 .BR ldap_next_reference (3) ,
 .BR ldap_first_message (3) ,
-.BR ldap_next_message (3)
+.BR ldap_next_message (3) ,
 or
 .BR ldap_result (3) .
 .LP
@@ -35,7 +38,7 @@ If no referrals were returned, \fI*referralsp\fP is set to NULL.
 .LP
 The \fIserverctrlsp\fP parameter will be filled in with an allocated array of
 controls copied from the parsed message. The array should be freed by calling
-.BR ldap_controls_free (3) .
+.BR ldap_controls_free (3).
 If \fIserverctrlsp\fP is NULL, no controls are returned.
 If no controls were returned, \fI*serverctrlsp\fP is set to NULL.
 .LP
@@ -48,14 +51,14 @@ routine can also be used to free the message later.
 Upon success LDAP_SUCCESS is returned. Otherwise the values of the
 \fIreferralsp\fP and \fIserverctrlsp\fP parameters are undefined.
 .SH SEE ALSO
-.BR ldap(3),
-.BR ldap_first_reference(3),
-.BR ldap_first_message(3),
-.BR ldap_result(3),
-.BR ldap_get_values(3),
-.BR ldap_controls_free(3)
+.BR ldap (3),
+.BR ldap_first_reference (3),
+.BR ldap_first_message (3),
+.BR ldap_result (3),
+.BR ldap_get_values (3),
+.BR ldap_controls_free (3)
 .SH ACKNOWLEDGEMENTS
-.B     OpenLDAP
+.B OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
+.B OpenLDAP
 is derived from University of Michigan LDAP 3.3 Release.