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  1999-07-25 "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 CONFORMING TO
  56 C99.
  57 .SH NOTES
  58 The behavior of
  59 .BR towctrans ()
  60 depends on the
  61 .B LC_CTYPE
  62 category of the
  63 current locale.
  64 .SH SEE ALSO
  65 .BR towlower (3),
  66 .BR towupper (3),
  67 .BR wctrans (3)