LDAP_GET_LANG_VALUES(3LDAP) LDAP Library Functions LDAP_GET_LANG_VALUES(3LDAP)
NAME
ldap_get_lang_values, ldap_get_lang_values_len - return an attribute's
values that matches a specified language subtype
SYNOPSIS
cc -flag ... file...
-lldap [
-library ... ]
#include <ldap.h>
char **ldap_get_lang_values(
LDAP *ld,
LDAPMessage *entry,
const char *target,
char **type struct berval **ldap_get_lang_values_len(
LDAP *ld,
LDAPMessage *entry,
const char *target,
char **typeDESCRIPTION
The
ldap_get_lang_values() function returns an array of an attribute's
string values that matches a specified language subtype. To retrieve the
binary data from an attribute, call the
ldap_get_lang_values_len() function instead.
ldap_get_lang_values() should be called to retrieve a null-terminated
array of an attribute's string values that match a specified language
subtype. The
entry parameter is the entry retrieved from the directory.
The
target parameter should contain the attribute type the values that
are required, including the optional language subtype. The
type parameter points to a buffer that returns the attribute type retrieved by
this function. Unlike the
ldap_get_values() function, if a language
subtype is specified, this function first attempts to find and return
values that match that subtype, for example,
cn;lang-en.
ldap_get_lang_values_len() returns a null-terminated array of pointers to
berval structures, each containing the length and pointer to a binary
value of an attribute for a given entry. The
entry parameter is the
result returned by
ldap_result() or
ldap_search_s() functions. The
target parameter is the attribute returned by the call to
ldap_first_attribute() or
ldap_next_attribute(), or the attribute as a literal string, such as
jpegPhoto or
audio.
These functions are deprecated. Use
ldap_get_values() or
ldap_get_values_len() instead.
RETURN VALUES
If successful,
ldap_get_lang_values() returns a null-terminated array of
the attribute's values. If the call is unsuccessful, or if no such
attribute exists in the
entry, it returns a
NULL and sets the appropriate
error code in the LDAP structure.
The
ldap_get_lang_values_len() function returns a null-terminated array
of pointers to
berval structures, which in turn, if successful, contain
pointers to the attribute's binary values. If the call is unsuccessful,
or if no such attribute exists in the
entry, it returns a
NULL and sets
the appropriate error code in the LDAP structure.
ATTRIBUTES
See
attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Obsolete |
+--------------------+-----------------+
SEE ALSO
ldap_first_attribute(3LDAP),
ldap_get_values(3LDAP),
ldap_result(3LDAP),
ldap_search(3LDAP),
attributes(7) February 21, 2023
LDAP_GET_LANG_VALUES(3LDAP)