From: Howard Chu <hyc@openldap.org>
Date: Thu, 22 Jan 2015 01:39:18 +0000 (+0000)
Subject: ITS#8032 document LDAP_OPT_API_INFO/FEATURE_INFO
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=9b4895561cb15359eefd76fbdf85214aa60459da;p=openldap

ITS#8032 document LDAP_OPT_API_INFO/FEATURE_INFO
---

diff --git a/doc/man/man3/ldap_get_option.3 b/doc/man/man3/ldap_get_option.3
index 1ec8fb3974..5843bd4b4a 100644
--- a/doc/man/man3/ldap_get_option.3
+++ b/doc/man/man3/ldap_get_option.3
@@ -38,6 +38,13 @@ Fills-in a
 must be a 
 .BR "LDAPAPIFeatureInfo *" ,
 pointing to an already allocated struct.
+The
+.B ldapaif_info_version
+field of the struct must be initialized to
+.B LDAP_FEATURE_INFO_VERSION
+before making the call. The
+.B ldapaif_name
+field must be set to the name of a feature to query.
 This is a read-only option.
 .TP
 .B LDAP_OPT_API_INFO
@@ -46,7 +53,20 @@ Fills-in a
 .BR outvalue 
 must be a 
 .BR "LDAPAPIInfo *" ,
-pointing to an already allocated struct.
+pointing to an already allocated struct. The
+.B ldapai_info_version
+field of the struct must be initialized to
+.B LDAP_API_INFO_VERSION
+before making the call.
+If the version passed in does not match the current library
+version, the expected version number will be stored in the
+struct and the call will fail.
+The caller is responsible for freeing the elements of the
+.B ldapai_extensions
+array and the array itself using
+.BR ldap_memfree (3).
+The caller must also free the
+.BR ldapi_vendor_name .
 This is a read-only option.
 .TP
 .B LDAP_OPT_CLIENT_CONTROLS