Edit

LDAPAPIFeatureInfoW structure (winldap.h)

  • Article

The LDAPAPIFeatureInfo structure retrieves data about any supported LDAP API extensions.

Syntax

typedef struct ldap_apifeature_infoW {
  int    ldapaif_info_version;
  PWCHAR ldapaif_name;
  int    ldapaif_version;
} LDAPAPIFeatureInfoW;

Members

ldapaif_info_version

The version of this structure, which must be set to LDAP_FEATURE_INFO_VERSION before the call to ldap_get_option is performed.

ldapaif_name

A pointer to a null-terminated string that contains the name of the desired API extension. This value is set before the call to ldap_get_option is performed, and should match one of the strings returned in the ldapai_extensions member of LDAPAPIInfo set from a previous call to ldap_get_option.

ldapaif_version

The vendor API extension version number. This implementation returns an integer value in the format of MMnnn, where MM is the major version number * 1000, and nnn is the minor version number. For example, version 1.001 would be returned as the number 1001.

Remarks

A pointer to this structure is passed, along with the LDAP_FEATURE_API_INFO session option and the name of the desired API extension, to ldap_get_option, to retrieve detailed data about the LDAP API extension.

Note

The winldap.h header defines LDAPAPIFeatureInfo as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Header winldap.h

See also

LDAPAPIInfo

Session Options

ldap_get_option