man3/towctrans.3

   1 '\" t
   2 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   3 .\"
   4 .\" SPDX-License-Identifier: GPL-2.0-or-later
   5 .\"
   6 .\" References consulted:
   7 .\"   GNU glibc-2 source code and manual
   8 .\"   Dinkumware C library reference http://www.dinkumware.com/
   9 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  10 .\"   ISO/IEC 9899:1999
  11 .\"
  12 .TH towctrans 3 (date) "Linux man-pages (unreleased)"
  13 .SH NAME
  14 towctrans \- wide-character transliteration
  15 .SH LIBRARY
  16 Standard C library
  17 .RI ( libc ", " \-lc )
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wctype.h>
  21 .PP
  22 .BI "wint_t towctrans(wint_t " wc ", wctrans_t " desc );
  23 .fi
  24 .SH DESCRIPTION
  25 If
  26 .I wc
  27 is a wide character, then the
  28 .BR towctrans ()
  29 function
  30 translates it according to the transliteration descriptor
  31 .IR desc .
  32 If
  33 .I wc
  34 is
  35 .BR WEOF ,
  36 .B WEOF
  37 is returned.
  38 .PP
  39 .I desc
  40 must be a transliteration descriptor returned by
  41 the
  42 .BR wctrans (3)
  43 function.
  44 .SH RETURN VALUE
  45 The
  46 .BR towctrans ()
  47 function returns the translated wide character,
  48 or
  49 .B WEOF
  50 if
  51 .I wc
  52 is
  53 .BR WEOF .
  54 .SH ATTRIBUTES
  55 For an explanation of the terms used in this section, see
  56 .BR attributes (7).
  57 .ad l
  58 .nh
  59 .TS
  60 allbox;
  61 lbx lb lb
  62 l l l.
  63 Interface       Attribute       Value
  64 T{
  65 .BR towctrans ()
  66 T}      Thread safety   MT-Safe
  67 .TE
  68 .hy
  69 .ad
  70 .sp 1
  71 .SH STANDARDS
  72 C11, POSIX.1-2008.
  73 .SH HISTORY
  74 POSIX.1-2001, C99.
  75 .SH NOTES
  76 The behavior of
  77 .BR towctrans ()
  78 depends on the
  79 .B LC_CTYPE
  80 category of the
  81 current locale.
  82 .SH SEE ALSO
  83 .BR towlower (3),
  84 .BR towupper (3),
  85 .BR wctrans (3)