lib/libc/locale/btowc.3

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