original/man3/wctrans.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .TH WCTRANS 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 wctrans \- wide-character translation mapping
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wctype.h>
  20 .sp
  21 .BI "wctrans_t wctrans(const char *" name );
  22 .fi
  23 .SH DESCRIPTION
  24 The \fIwctrans_t\fP type represents a mapping
  25 which can map a wide character to
  26 another wide character.
  27 Its nature is implementation-dependent, but the special
  28 value \fI(wctrans_t)\ 0\fP denotes an invalid mapping.
  29 Nonzero \fIwctrans_t\fP
  30 values can be passed to the
  31 .BR towctrans (3)
  32 function to actually perform
  33 the wide-character mapping.
  34 .PP
  35 The
  36 .BR wctrans ()
  37 function returns a mapping, given by its name.
  38 The set of
  39 valid names depends on the
  40 .B LC_CTYPE
  41 category of the current locale, but the
  42 following names are valid in all locales.
  43 .nf
  44   "tolower" \- realizes the \fBtolower\fP(3) mapping
  45   "toupper" \- realizes the \fBtoupper\fP(3) mapping
  46 .fi
  47 .SH "RETURN VALUE"
  48 The
  49 .BR wctrans ()
  50 function returns a mapping descriptor if the \fIname\fP
  51 is valid.
  52 Otherwise it returns \fI(wctrans_t) 0\fP.
  53 .SH "CONFORMING TO"
  54 C99.
  55 .SH NOTES
  56 The behavior of
  57 .BR wctrans ()
  58 depends on the
  59 .B LC_CTYPE
  60 category of the
  61 current locale.
  62 .SH "SEE ALSO"
  63 .BR towctrans (3)