man3/wctrans.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_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  1999-07-25 "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 \fIwctrans_t\fP type represents a mapping
  27 which can map a wide character to
  28 another wide character.
  29 Its nature is implementation-dependent, but the special
  30 value \fI(wctrans_t)\ 0\fP denotes an invalid mapping.
  31 Nonzero \fIwctrans_t\fP
  32 values can be passed to the
  33 .BR towctrans (3)
  34 function to actually perform
  35 the wide-character mapping.
  36 .PP
  37 The
  38 .BR wctrans ()
  39 function returns a mapping, given by its name.
  40 The set of
  41 valid names depends on the
  42 .B LC_CTYPE
  43 category of the current locale, but the
  44 following names are valid in all locales.
  45 .nf
  46   "tolower" \- realizes the \fBtolower\fP(3) mapping
  47   "toupper" \- realizes the \fBtoupper\fP(3) mapping
  48 .fi
  49 .SH RETURN VALUE
  50 The
  51 .BR wctrans ()
  52 function returns a mapping descriptor if the \fIname\fP
  53 is valid.
  54 Otherwise it returns \fI(wctrans_t) 0\fP.
  55 .SH CONFORMING TO
  56 C99.
  57 .SH NOTES
  58 The behavior of
  59 .BR wctrans ()
  60 depends on the
  61 .B LC_CTYPE
  62 category of the
  63 current locale.
  64 .SH SEE ALSO
  65 .BR towctrans (3)