man3/wctrans.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH WCTRANS 3  2015-08-08 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wctrans \- wide-character translation mapping
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wctype.h>
  22 .sp
  23 .BI "wctrans_t wctrans(const char *" name );
  24 .fi
  25 .SH DESCRIPTION
  26 The
  27 .I wctrans_t
  28 type represents a mapping
  29 which can map a wide character to
  30 another wide character.
  31 Its nature is implementation-dependent, but the special
  32 value
  33 .IR "(wctrans_t)\ 0"
  34 denotes an invalid mapping.
  35 Nonzero
  36 .I wctrans_t
  37 values can be passed to the
  38 .BR towctrans (3)
  39 function to actually perform
  40 the wide-character mapping.
  41 .PP
  42 The
  43 .BR wctrans ()
  44 function returns a mapping, given by its name.
  45 The set of
  46 valid names depends on the
  47 .B LC_CTYPE
  48 category of the current locale, but the
  49 following names are valid in all locales.
  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 .TS
  66 allbox;
  67 lb lb lb
  68 l l l.
  69 Interface       Attribute       Value
  70 T{
  71 .BR wctrans ()
  72 T}      Thread safety   MT-Safe locale
  73 .TE
  74 .SH CONFORMING TO
  75 POSIX.1-2001, POSIX.1-2008, C99.
  76 .SH NOTES
  77 The behavior of
  78 .BR wctrans ()
  79 depends on the
  80 .B LC_CTYPE
  81 category of the
  82 current locale.
  83 .SH SEE ALSO
  84 .BR towctrans (3)