1ldap_get_lang_values(3LDAP) LDAP Library Functions ldap_get_lang_values(3LDAP)
2
3
4

NAME

6       ldap_get_lang_values,  ldap_get_lang_values_len - return an attribute's
7       values that matches a specified language subtype
8

SYNOPSIS

10       cc -flag ... file...-lldap [ -library ... ]
11       #include <ldap.h>
12
13       char **ldap_get_lang_values(LDAP *ld, LDAPMessage *entry,
14            const char *target, char **type
15
16
17       struct berval **ldap_get_lang_values_len(LDAP *ld, LDAPMessage *entry,
18            const char *target, char **type
19
20

DESCRIPTION

22       The ldap_get_lang_values() function returns an array of an  attribute's
23       string  values  that  matches a specified language subtype. To retrieve
24       the binary data from an attribute, call the  ldap_get_lang_values_len()
25       function instead.
26
27
28       ldap_get_lang_values()  should  be called to retrieve a null-terminated
29       array of an attribute's string values that match a  specified  language
30       subtype. The entry parameter is the entry retrieved from the directory.
31       The target parameter should contain the attribute type the values  that
32       are required, including the optional language subtype. The type  param‐
33       eter points to a buffer that returns the attribute  type  retrieved  by
34       this  function.  Unlike  the  ldap_get_values() function, if a language
35       subtype is specified, this function first attempts to find  and  return
36       values that match that subtype, for example, cn;lang-en.
37
38
39       ldap_get_lang_values_len()  returns a null-terminated array of pointers
40       to berval structures, each containing  the  length  and  pointer  to  a
41       binary  value of an attribute for a given entry. The entry parameter is
42       the result returned by ldap_result() or ldap_search_s() functions.  The
43       target   parameter   is   the   attribute   returned  by  the  call  to
44       ldap_first_attribute() or ldap_next_attribute(), or the attribute as  a
45       literal string, such as jpegPhoto or audio.
46
47
48       These  functions are deprecated. Use ldap_get_values() or ldap_get_val‐
49       ues_len() instead.
50

RETURN VALUES

52       If successful, ldap_get_lang_values() returns a  null-terminated  array
53       of  the  attribute's values. If the call is unsuccessful, or if no such
54       attribute exists in the entry, it returns a NULL and sets the appropri‐
55       ate error code in the LDAP structure.
56
57
58       The ldap_get_lang_values_len() function returns a null-terminated array
59       of pointers to berval structures, which in turn, if successful, contain
60       pointers  to  the  attribute's binary values. If the call is unsuccess‐
61       ful, or if no such attribute exists in the entry, it returns a NULL and
62       sets the appropriate error code in the LDAP structure.
63

ATTRIBUTES

65       See attributes(5)  for descriptions of the following attributes:
66
67
68
69
70       ┌─────────────────────────────┬─────────────────────────────┐
71       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
72       ├─────────────────────────────┼─────────────────────────────┤
73       │Availability                 │SUNWcsl (32-bit)             │
74       ├─────────────────────────────┼─────────────────────────────┤
75       │                             │SUNWcslx (64-bit)            │
76       ├─────────────────────────────┼─────────────────────────────┤
77       │Interface Stability          │Obsolete                     │
78       └─────────────────────────────┴─────────────────────────────┘
79

SEE ALSO

81       ldap_first_attribute(3LDAP), ldap_first_attribute(3LDAP), ldap_get_val‐
82       ues(3LDAP), ldap_result(3LDAP), ldap_search(3LDAP), attributes(5)
83
84
85
86SunOS 5.11                        25 Oct 2001      ldap_get_lang_values(3LDAP)
Impressum