original/man3/towctrans.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 TOWCTRANS 3  2013-12-24 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 towctrans \- wide-character transliteration
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <wctype.h>
  22 .sp
  23 .BI "wint_t towctrans(wint_t " wc ", wctrans_t " desc );
  24 .fi
  25 .SH DESCRIPTION
  26 If
  27 .I wc
  28 is a wide character, the
  29 .BR towctrans ()
  30 function
  31 translates it according to the transliteration descriptor
  32 .IR desc .
  33 If
  34 .IR wc
  35 is
  36 .BR WEOF ,
  37 .B WEOF
  38 is returned.
  39 .PP
  40 .I desc
  41 must be a transliteration descriptor returned by
  42 the
  43 .BR wctrans (3)
  44 function.
  45 .SH RETURN VALUE
  46 The
  47 .BR towctrans ()
  48 function returns the translated wide character,
  49 or
  50 .BR WEOF
  51 if
  52 .I wc
  53 is
  54 .BR WEOF .
  55 .SH ATTRIBUTES
  56 .SS Multithreading (see pthreads(7))
  57 The
  58 .BR towctrans ()
  59 function is thread-safe.
  60 .SH CONFORMING TO
  61 C99.
  62 .SH NOTES
  63 The behavior of
  64 .BR towctrans ()
  65 depends on the
  66 .B LC_CTYPE
  67 category of the
  68 current locale.
  69 .SH SEE ALSO
  70 .BR towlower (3),
  71 .BR towupper (3),
  72 .BR wctrans (3)
  73 .SH COLOPHON
  74 This page is part of release 3.79 of the Linux
  75 .I man-pages
  76 project.
  77 A description of the project,
  78 information about reporting bugs,
  79 and the latest version of this page,
  80 can be found at
  81 \%http://www.kernel.org/doc/man\-pages/.