LDAPAPIInfo

The LDAPAPIInfo structure retrieves data about the API and implementations used.

typedef struct ldapapiinfo {

  int ldapai_info_version;

  int ldapai_api_version;

  int ldapai_protocol_version;

  char** ldapai_extensions;

  char* ldapai_vendor_name;

  int ldapai_vendor_version;
} LDAPAPIInfo;

Members

ldapai_info_version

The version of this structure, which must be set to LDAP_API_INFO_VERSION before a call to ldap_get_option.

ldapai_api_version

The current revision number of this LDAP API library.

ldapai_protocol_version

The highest LDAP version supported by this LDAP API library.

ldapai_extensions

A pointer to an array of null-terminated strings that indicate what API extensions are supported.

ldapai_vendor_name

A pointer to a null-terminated string that contains the name of the API vendor. This implementation returns the string "Microsoft Corporation.".

ldapai_vendor_version

The API vendor version number. This implementation returns an integer value in the format of MMnn, where MM is the major version number * 100, and nn is the minor version number. For example, version 5.10 returns as 510.

Remarks

A pointer to this structure is passed with the LDAP_OPT_API_INFO session option, to ldap_get_option, in order to retrieve data about this LDAP API library. The data returned includes a list of any API extensions supported by the implementation. When the structure data is no longer required, the caller must free the individual strings and string arrays returned in this structure by using the ldap_memfree and ldap_value_free functions.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 family and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows Me/98/95.
Unicode: Declared as Unicode and ANSI structures.
Header: Declared in Winldap.h.

See Also

ldap_get_option, ldap_memfree, ldap_value_free, Session Options