mirror/openldap
2
0
Fork 0
mirror of https://git.openldap.org/openldap/openldap.git synced 2025-01-24 11:14:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

ITS#8032 document LDAP_OPT_API_INFO/FEATURE_INFO

Browse Source
This commit is contained in:
Howard Chu 2015-01-22 01:39:18 +00:00
parent e2b4366044
commit 9b4895561c
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/man/man3/ldap_get_option.3
View File

@ -38,6 +38,13 @@ Fills-in a
must be a must be a
.BR "LDAPAPIFeatureInfo *" , .BR "LDAPAPIFeatureInfo *" ,
pointing to an already allocated struct. 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. This is a read-only option.
.TP .TP
.B LDAP_OPT_API_INFO .B LDAP_OPT_API_INFO
@ -46,7 +53,20 @@ Fills-in a
.BR outvalue .BR outvalue
must be a must be a
.BR "LDAPAPIInfo *" , .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. This is a read-only option.
.TP .TP
.B LDAP_OPT_CLIENT_CONTROLS .B LDAP_OPT_CLIENT_CONTROLS