From f993c9f45c6ec5b2c164af6b8e7f4fb71bc901a4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ond=C5=99ej=20Kuzn=C3=ADk?= <ondra@mistotebe.net>
Date: Wed, 27 May 2020 15:50:24 +0100
Subject: [PATCH] ITS#9271 Document ldap_parse_intermediate

---
 doc/man/man3/ldap_parse_result.3       | 13 ++++++++++---
 doc/man/man3/ldap_parse_result.3.links |  1 +
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/doc/man/man3/ldap_parse_result.3 b/doc/man/man3/ldap_parse_result.3
index d2ca18e711..1e18d525b1 100644
--- a/doc/man/man3/ldap_parse_result.3
+++ b/doc/man/man3/ldap_parse_result.3
@@ -24,6 +24,11 @@ int ldap_parse_sasl_bind_result( LDAP *ld, LDAPMessage *result,
 .ft B
 int ldap_parse_extended_result( LDAP *ld, LDAPMessage *result,
 	char **retoidp, struct berval **retdatap, int freeit )
+.LP
+.ft B
+int ldap_parse_intermediate( LDAP *ld, LDAPMessage *result,
+	char **retoidp, struct berval **retdatap,
+	LDAPControl ***serverctrlsp, int freeit )
 .SH DESCRIPTION
 .LP
 These routines are used to extract information from a result message.
@@ -41,7 +46,9 @@ the routines
 and
 .B ldap_parse_extended_result()
 are used to get all the result information from SASL bind and extended
-operations.
+operations. To extract information from intermediate responses,
+.B ldap_parse_intermediate()
+can be used.
 .LP
 The \fIerrcodep\fP parameter will be filled in with the result code from
 the result message.
@@ -77,13 +84,13 @@ with an allocated berval structure containing the credentials from the
 server if present. The structure should be freed using
 .BR ber_bvfree (3).
 .LP
-For extended results, the \fIretoidp\fP parameter will be filled in
+For extended results and intermediate responses, the \fIretoidp\fP parameter will be filled in
 with the dotted-OID text representation of the name of the extended
 operation response. The string should be freed using
 .BR ldap_memfree (3).
 If no OID was returned, \fI*retoidp\fP is set to NULL.
 .LP
-For extended results, the \fIretdatap\fP parameter will be filled in
+For extended results and intermediate responses, the \fIretdatap\fP parameter will be filled in
 with a pointer to a berval structure containing the data from the
 extended operation response. The structure should be freed using
 .BR ber_bvfree (3).
diff --git a/doc/man/man3/ldap_parse_result.3.links b/doc/man/man3/ldap_parse_result.3.links
index 9c322c36a5..e2f4755c35 100644
--- a/doc/man/man3/ldap_parse_result.3.links
+++ b/doc/man/man3/ldap_parse_result.3.links
@@ -1,2 +1,3 @@
 ldap_parse_sasl_bind_result.3
 ldap_parse_extended_result.3
+ldap_parse_intermediate.3
-- 
GitLab