ldap_get_valuesW function (winldap.h)
The ldap_get_values function retrieves the list of values of a given attribute.
Syntax
WINLDAPAPI PWCHAR *LDAPAPI ldap_get_valuesW(
[in] LDAP *ld,
[in] LDAPMessage *entry,
[in] const PWSTR attr
);
Parameters
[in] ld
The session handle.
[in] entry
The entry from which to retrieve values.
[in] attr
A pointer to a null-terminated string that contains the attribute whose values are to be retrieved.
Return value
If the function succeeds, it returns a null-terminated list of pointers to values. If no attribute values were found, it usually returns NULL. But in some cases it may return a list one pointer that is NULL. Always make sure to use ldap_count_values to get the count of values in the returned list, as noted in Remarks. The session error parameter in the LDAP data structure is set to 0 in either case.
If the function fails, it returns NULL and the session error parameter in the LDAP data structure is set to the LDAP error code.
Remarks
Use ldap_get_values when parsing a search response to obtain the value or values of an attribute. Use this function only when the attribute contains null-terminated character strings; for binary data, use ldap_get_values_len instead.
The entry is obtained by calling ldap_first_entry or ldap_next_entry. The attribute should be one returned by a call to ldap_first_attribute, ldap_next_attribute, or a caller-supplied string (for example, "mail").
Use ldap_count_values to get the count of values in the returned list. Call ldap_value_free to release the returned value when it is no longer required.
Certain LDAP servers place limits on the number of attribute string values that are returned in a single call. For more information about using range retrieval specifiers, see Searching Using Range Retrieval.
Note
The winldap.h header defines ldap_get_values as an alias that 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 is 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 |
| Target Platform | Windows |
| Header | winldap.h |
| Library | Wldap32.lib |
| DLL | Wldap32.dll |