lib/libc/locale/towctrans.3

   1 .\" $NetBSD: src/lib/libc/locale/towctrans.3,v 1.5 2004/01/24 16:58:54 wiz Exp $
   2 .\" $DragonFly: src/lib/libc/locale/towctrans.3,v 1.1 2005/03/12 00:18:01 joerg Exp $
   3 .\"
   4 .\" Copyright (c)2003 Citrus Project,
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd March 4, 2003
  29 .Dt TOWCTRANS 3
  30 .Os
  31 .\" ----------------------------------------------------------------------
  32 .Sh NAME
  33 .Nm towctrans
  34 .Nd convert a wide character with a specified map
  35 .\" ----------------------------------------------------------------------
  36 .Sh LIBRARY
  37 .Lb libc
  38 .\" ----------------------------------------------------------------------
  39 .Sh SYNOPSIS
  40 .In wctype.h
  41 .Ft wint_t
  42 .Fn towctrans "wint_t wc" "wctrans_t charmap"
  43 .\" ----------------------------------------------------------------------
  44 .Sh DESCRIPTION
  45 The
  46 .Fn towctrans
  47 function converts a wide character
  48 .Fa wc
  49 with a character mapping
  50 .Fa charmap .
  51 .Pp
  52 The behaviour of
  53 .Fn towctrans
  54 is undefined if the
  55 .Fn towctrans
  56 function is called with an invalid
  57 .Fa charmap
  58 (changes of
  59 .Dv LC_CTYPE
  60 category invalidate
  61 .Fa charclass )
  62 or invalid wide character
  63 .Fa wc .
  64 .Pp
  65 The behaviour of
  66 .Fn towctrans
  67 is affected by the
  68 .Dv LC_CTYPE
  69 category of the current locale.
  70 .\" ----------------------------------------------------------------------
  71 .Sh RETURN VALUES
  72 .Fn towctrans
  73 returns the resulting character of the conversion.
  74 .\" ----------------------------------------------------------------------
  75 .Sh ERRORS
  76 No errors are defined.
  77 .\" ----------------------------------------------------------------------
  78 .Sh SEE ALSO
  79 .Xr iswctype 3 ,
  80 .Xr setlocale 3 ,
  81 .Xr wctrans 3 ,
  82 .Xr wctype 3
  83 .\" ----------------------------------------------------------------------
  84 .Sh STANDARDS
  85 The
  86 .Fn towctrans
  87 function conforms to
  88 .St -isoC-amd1 .