Libc-1082.50.1.tar.gz

[apple/libc.git] / locale / FreeBSD / btowc.3

.\" Copyright (c) 2002 Tim J. Robbins
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/lib/libc/locale/btowc.3,v 1.2 2002/11/10 11:14:58 tjr Exp $
.\"
.Dd August 3, 2002
.Dt BTOWC 3
.Os
.Sh NAME
.Nm btowc ,
.Nm btowc_l ,
.Nm wctob ,
.Nm wctob_l
.Nd "convert between wide and single-byte characters"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.In wchar.h
.Ft wint_t
.Fo btowc
.Fa "int c"
.Fc
.Ft int
.Fo wctob
.Fa "wint_t c"
.Fc
.In wchar.h
.In xlocale.h
.Ft wint_t
.Fo btowc_l
.Fa "int c"
.Fa "locale_t loc"
.Fc
.Ft int
.Fo wctob_l
.Fa "wint_t c"
.Fa "locale_t loc"
.Fc
.Sh DESCRIPTION
The
.Fn btowc
function converts a single-byte character into a corresponding wide character.
If the character is
.Dv EOF
or not valid in the initial shift state,
.Fn btowc
returns
.Dv WEOF .
.Pp
The
.Fn wctob
function converts a wide character into a corresponding single-byte character.
If the wide character is
.Dv WEOF
or not able to be represented as a single byte in the initial shift state,
.Fn wctob
returns
.Dv WEOF .
.Pp
While the
.Fn btowc
and
.Fn wctob
functions use the current locale, the
.Fn btowc_l
and
.Fn wctob_l
functions may be passed locales directly. See
.Xr xlocale 3
for more information.
.Sh LEGACY SYNOPSIS
.Pp
The include file
.In stdio.h
is not necessary for these functions.
.Sh SEE ALSO
.Xr mbrtowc 3 ,
.Xr multibyte 3 ,
.Xr wcrtomb 3 ,
.Xr xlocale 3 ,
.Xr compat 5
.Sh STANDARDS
The
.Fn btowc
and
.Fn wctob
functions conform to
.St -p1003.1-2001 .
.Sh HISTORY
The
.Fn btowc
and
.Fn wctob
functions first appeared in
.Fx 5.0 .