locale/FreeBSD/btowc.3

   1 .\" Copyright (c) 2002 Tim J. Robbins
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc/locale/btowc.3,v 1.2 2002/11/10 11:14:58 tjr Exp $
  26 .\"
  27 .Dd August 3, 2002
  28 .Dt BTOWC 3
  29 .Os
  30 .Sh NAME
  31 .Nm btowc ,
  32 .Nm wctob
  33 .Nd "convert between wide and single-byte characters"
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In wchar.h
  38 .Ft wint_t
  39 .Fn btowc "int c"
  40 .Ft int
  41 .Fn wctob "wint_t c"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn btowc
  45 function converts a single-byte character into a corresponding wide character.
  46 If the character is
  47 .Dv EOF
  48 or not valid in the initial shift state,
  49 .Fn btowc
  50 returns
  51 .Dv WEOF .
  52 .Pp
  53 The
  54 .Fn wctob
  55 function converts a wide character into a corresponding single-byte character.
  56 If the wide character is
  57 .Dv WEOF
  58 or not able to be represented as a single byte in the initial shift state,
  59 .Fn wctob
  60 returns
  61 .Dv WEOF .
  62 .Sh SEE ALSO
  63 .Xr mbrtowc 3 ,
  64 .Xr multibyte 3 ,
  65 .Xr wcrtomb 3
  66 .Sh STANDARDS
  67 The
  68 .Fn btowc
  69 and
  70 .Fn wctob
  71 functions conform to
  72 .St -p1003.1-2001 .
  73 .Sh HISTORY
  74 The
  75 .Fn btowc
  76 and
  77 .Fn wctob
  78 functions first appeared in
  79 .Fx 5.0 .