man3/wctrans.3

   1 '\" t
   2 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   3 .\"
   4 .\" SPDX-License-Identifier: GPL-2.0-or-later
   5 .\"
   6 .\" References consulted:
   7 .\"   GNU glibc-2 source code and manual
   8 .\"   Dinkumware C library reference http://www.dinkumware.com/
   9 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  10 .\"   ISO/IEC 9899:1999
  11 .\"
  12 .TH wctrans 3 (date) "Linux man-pages (unreleased)"
  13 .SH NAME
  14 wctrans \- wide-character translation mapping
  15 .SH LIBRARY
  16 Standard C library
  17 .RI ( libc ", " \-lc )
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wctype.h>
  21 .PP
  22 .BI "wctrans_t wctrans(const char *" name );
  23 .fi
  24 .SH DESCRIPTION
  25 The
  26 .I wctrans_t
  27 type represents a mapping
  28 which can map a wide character to
  29 another wide character.
  30 Its nature is implementation-dependent, but the special
  31 value
  32 .I (wctrans_t)\ 0
  33 denotes an invalid mapping.
  34 Nonzero
  35 .I wctrans_t
  36 values can be passed to the
  37 .BR towctrans (3)
  38 function to actually perform
  39 the wide-character mapping.
  40 .PP
  41 The
  42 .BR wctrans ()
  43 function returns a mapping, given by its name.
  44 The set of
  45 valid names depends on the
  46 .B LC_CTYPE
  47 category of the current locale, but the
  48 following names are valid in all locales.
  49 .PP
  50 .nf
  51     "tolower" \- realizes the \fBtolower\fP(3) mapping
  52     "toupper" \- realizes the \fBtoupper\fP(3) mapping
  53 .fi
  54 .SH RETURN VALUE
  55 The
  56 .BR wctrans ()
  57 function returns a mapping descriptor if the
  58 .I name
  59 is valid.
  60 Otherwise, it returns
  61 .IR "(wctrans_t)\ 0" .
  62 .SH ATTRIBUTES
  63 For an explanation of the terms used in this section, see
  64 .BR attributes (7).
  65 .ad l
  66 .nh
  67 .TS
  68 allbox;
  69 lbx lb lb
  70 l l l.
  71 Interface       Attribute       Value
  72 T{
  73 .BR wctrans ()
  74 T}      Thread safety   MT-Safe locale
  75 .TE
  76 .hy
  77 .ad
  78 .sp 1
  79 .SH STANDARDS
  80 POSIX.1-2001, POSIX.1-2008, C99.
  81 .SH NOTES
  82 The behavior of
  83 .BR wctrans ()
  84 depends on the
  85 .B LC_CTYPE
  86 category of the
  87 current locale.
  88 .SH SEE ALSO
  89 .BR towctrans (3)