ldap_get_values()--Retrieve a Set of Attribute Values from an Entry

Syntax

 #include <ldap.h>
 
 char **ldap_get_values(
                LDAP          *ld,
                LDAPMessage   *entry,
                const char    *attr)

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_get_values() function is used to retrieve attribute values from an LDAP entry as returned by ldap_first_entry() or ldap_next_entry(). ldap_get_values() uses the entry and the attribute attr whose values are wanted and returns a NULL-terminated array of the attribute's values. The returned array should be freed with ldap_value_free() when it is no longer needed.

Use ldap_get_values_len() to get binary attribute values.

Authorities and Locks

No IBM^® i authority is required.

Parameters

ld: (Input) Specifies the LDAP pointer returned by a previous call to ldap_init(), ldap_ssl_init(), or ldap_open().
entry: (Input) Specifies an LDAP entry as returned from ldap_first_entry() or ldap_next_entry().
attr: (Input) Specifies the attribute whose values are desired.

Return Value

Array of Values: if the request was successful.
NULL: if the request was not successful.

Error Conditions

The ldap_get_values() API will return NULL and set the ld_errno error code, if not successful. See LDAP Client API Error Conditions for possible LDAP error code values.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_get_values API.

Related Information

ldap_get_values_len() -- Return an attribute's binary values.
ldap_count_values() -- Return number of values.
ldap_count_values_len() -- Return number of binary values.
ldap_value_free() -- Free memory allocated by ldap_get_values().
ldap_value_free_len() -- Free memory allocated by ldap_get_values_len().

API introduced: V4R3

[ Back to top | LDAP APIs | APIs by category ]