X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman3%2Fldap_get_option.3;h=cd08593622336670558913595e4e5b5c1d65ff44;hb=59e9ff6243465640956b58ad1756a3ede53eca7c;hp=1ec8fb397419152182f607dfa2e36b5b29ebb342;hpb=2d731f88767860dbb3c8bd20583e60900461fc94;p=openldap diff --git a/doc/man/man3/ldap_get_option.3 b/doc/man/man3/ldap_get_option.3 index 1ec8fb3974..cd08593622 100644 --- a/doc/man/man3/ldap_get_option.3 +++ b/doc/man/man3/ldap_get_option.3 @@ -1,6 +1,6 @@ .TH LDAP_GET_OPTION 3 "RELEASEDATE" "OpenLDAP LDVERSION" .\" $OpenLDAP$ -.\" Copyright 1998-2014 The OpenLDAP Foundation All Rights Reserved. +.\" Copyright 1998-2018 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .SH NAME ldap_get_option, ldap_set_option \- LDAP option handling routines @@ -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