cleanup

[openldap] / doc / man / man3 / ldap_result.3

diff --git a/doc/man/man3/ldap_result.3 b/doc/man/man3/ldap_result.3
index 29e1f1c65f548962631051d0eaa966623e6c53d5..607eed15fb12021571f0c6b33043ac21c0359c9a 100644 (file)
--- a/doc/man/man3/ldap_result.3
+++ b/doc/man/man3/ldap_result.3
@@ -1,9 +1,11 @@
-.TH LDAP_RESULT 3 "22 September 1998" "OpenLDAP LDVERSION"
+.TH LDAP_RESULT 3 "RELEASEDATE" "OpenLDAP LDVERSION"

 .\" $OpenLDAP$
 .\" $OpenLDAP$

-.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.

 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldap_result \- Wait for the result of an LDAP operation
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldap_result \- Wait for the result of an LDAP operation

+.SH LIBRARY
+OpenLDAP LDAP (libldap, -lldap)

 .SH SYNOPSIS
 .nf
 .ft B
 .SH SYNOPSIS
 .nf
 .ft B


@@ -60,17 +62,18 @@ the responses of a search operation.
 .LP
 A search response is made up of zero or
 more search entries, zero or more search references, and zero or
 .LP
 A search response is made up of zero or
 more search entries, zero or more search references, and zero or

-more extended parital responses followed by a search result.  If
+more extended partial responses followed by a search result.  If

 \fIall\fP is set to 0, search entries will be returned one at a
 time as they come in, via separate calls to
 .BR ldap_result() .
 If it's set to 1, the search
 response will only be returned in its entirety, i.e., after all entries,
 \fIall\fP is set to 0, search entries will be returned one at a
 time as they come in, via separate calls to
 .BR ldap_result() .
 If it's set to 1, the search
 response will only be returned in its entirety, i.e., after all entries,

-all references, all extended parital responses, and the final search
+all references, all extended partial responses, and the final search

 result have been received.
 .LP
 Upon success, the type of the result received is returned and the
 result have been received.
 .LP
 Upon success, the type of the result received is returned and the

-\fIresult\fP parameter will contain the result of the operation.  This
+\fIresult\fP parameter will contain the result of the operation;
+otherwise, the \fIresult\fP parameter is undefined.  This

 result should be passed to the LDAP parsing routines,
 .BR ldap_first_message (3)
 and friends, for interpretation.
 result should be passed to the LDAP parsing routines,
 .BR ldap_first_message (3)
 and friends, for interpretation.


@@ -94,13 +97,14 @@ The possible result types returned are:
 The
 .B ldap_msgfree()
 routine is used to free the memory allocated for
 The
 .B ldap_msgfree()
 routine is used to free the memory allocated for

-a result by
+result(s) by

 .B ldap_result()
 or
 .BR ldap_search_s (3)
 .B ldap_result()
 or
 .BR ldap_search_s (3)

-and friends.  It takes
-a pointer to the result to be freed and returns the type of the
-message it freed.
+and friends.
+It takes a pointer to the result or result chain to be freed and returns
+the type of the last message in the chain.
+If the parameter is NULL, the function does nothing and returns zero.

 .LP
 The
 .B ldap_msgtype()
 .LP
 The
 .B ldap_msgtype()


@@ -123,7 +127,7 @@ return -1 on error.
 .BR ldap_first_message (3),
 .BR select (2)
 .SH ACKNOWLEDGEMENTS
 .BR ldap_first_message (3),
 .BR select (2)
 .SH ACKNOWLEDGEMENTS

-.B     OpenLDAP
+.B OpenLDAP

 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 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.  
 is derived from University of Michigan LDAP 3.3 Release.