usr/src/man/man3ldap/ldap_get_lang_values.3ldap

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2001, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH LDAP_GET_LANG_VALUES 3LDAP "February 21, 2023"
   8 .SH NAME
   9 ldap_get_lang_values, ldap_get_lang_values_len \- return an attribute's  values
  10 that matches a specified language subtype
  11 .SH SYNOPSIS
  12 .nf
  13 \fBcc\fR \fB-flag \&.\|.\|.\fR \fIfile\fR\&.\|.\|.\fB-l\fRldap [\fB -library \&.\|.\|. \fR]
  14 #include <ldap.h>
  15
  16 \fBchar **\fR\fBldap_get_lang_values\fR(\fBLDAP *\fR\fIld\fR, \fBLDAPMessage *\fR\fIentry\fR,
  17      \fBconst char *\fR\fItarget\fR,\ \fBchar **\fR\fItype\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBstruct berval **\fR\fBldap_get_lang_values_len\fR(\fBLDAP *\fR\fIld\fR, \fBLDAPMessage *\fR\fIentry\fR,
  23      \fBconst char *\fR\fItarget\fR, \fBchar **\fR\fItype\fR
  24 .fi
  25
  26 .SH DESCRIPTION
  27 The \fBldap_get_lang_values()\fR function returns an array of an attribute's
  28 string values that matches a specified language subtype. To retrieve the binary
  29 data from an attribute, call the \fBldap_get_lang_values_len()\fR function
  30 instead.
  31 .sp
  32 .LP
  33 \fBldap_get_lang_values()\fR should be called to retrieve a null-terminated
  34 array of an attribute's string values that match a specified language  subtype.
  35 The \fIentry\fR parameter is the entry retrieved from the directory.   The
  36 \fItarget\fR parameter should contain the attribute type the values that are
  37 required, including the optional language subtype. The \fItype\fR  parameter
  38 points to a buffer that returns the attribute type retrieved by  this function.
  39 Unlike the \fBldap_get_values()\fR function, if a language subtype is
  40 specified, this function first attempts to find and return      values that
  41 match that subtype, for example, \fBcn;lang-en\fR.
  42 .sp
  43 .LP
  44 \fBldap_get_lang_values_len()\fR returns a null-terminated array of pointers
  45 to \fBberval\fR structures, each containing the length and pointer to a binary
  46 value of an attribute for a given entry. The \fIentry\fR parameter is the
  47 result returned by \fBldap_result()\fR or \fBldap_search_s()\fR functions. The
  48 \fItarget\fR parameter is the attribute returned by the call to
  49 \fBldap_first_attribute()\fR or \fBldap_next_attribute()\fR, or the attribute
  50 as a  literal string, such as \fBjpegPhoto\fR or \fBaudio\fR.
  51 .sp
  52 .LP
  53 These functions are deprecated. Use \fBldap_get_values()\fR or
  54 \fBldap_get_values_len()\fR instead.
  55 .SH RETURN VALUES
  56 If successful, \fBldap_get_lang_values()\fR returns a null-terminated array of
  57 the attribute's values. If the call is unsuccessful, or if no such attribute
  58 exists in the \fIentry\fR, it returns a \fINULL\fR and sets the appropriate
  59 error code in the LDAP structure.
  60 .sp
  61 .LP
  62 The \fBldap_get_lang_values_len()\fR function returns a null-terminated array
  63 of pointers to \fBberval\fR structures, which in turn, if successful, contain
  64 pointers to the  attribute's binary values. If the call is unsuccessful, or if
  65 no such attribute exists in the \fIentry\fR, it returns a \fINULL\fR and sets
  66 the appropriate error code in the LDAP structure.
  67 .SH ATTRIBUTES
  68 See \fBattributes\fR(7)  for descriptions of the following attributes:
  69 .sp
  70
  71 .sp
  72 .TS
  73 box;
  74 c | c
  75 l | l .
  76 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  77 _
  78 Interface Stability     Obsolete
  79 .TE
  80
  81 .SH SEE ALSO
  82 .BR ldap_first_attribute (3LDAP),
  83 .BR ldap_get_values (3LDAP),
  84 .BR ldap_result (3LDAP),
  85 .BR ldap_search (3LDAP),
  86 .BR attributes (7)