[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 wctob
.Nd "convert between wide and single-byte characters"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft wint_t
.Fn btowc "int c"
.Ft int
.Fn wctob "wint_t c"
.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 .
.Sh SEE ALSO
.Xr mbrtowc 3 ,
.Xr multibyte 3 ,
.Xr wcrtomb 3
.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 .
Commit	Line	Data
9385eb3d	1	.\" Copyright (c) 2002 Tim J. Robbins
5b2abdfb A	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	.\"
9385eb3d	25	.\" $FreeBSD: src/lib/libc/locale/btowc.3,v 1.2 2002/11/10 11:14:58 tjr Exp $
5b2abdfb	26	.\"
9385eb3d A	27	.Dd August 3, 2002
9385eb3d A	28	.Dt BTOWC 3
5b2abdfb A	29	.Os
5b2abdfb A	30	.Sh NAME
9385eb3d A	31	.Nm btowc ,
	32	.Nm wctob
	33	.Nd "convert between wide and single-byte characters"
5b2abdfb A	34	.Sh LIBRARY
	35	.Lb libc
	36	.Sh SYNOPSIS
9385eb3d A	37	.In wchar.h
	38	.Ft wint_t
	39	.Fn btowc "int c"
5b2abdfb	40	.Ft int
9385eb3d	41	.Fn wctob "wint_t c"
5b2abdfb	42	.Sh DESCRIPTION
9385eb3d A	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 .
5b2abdfb	52	.Pp
9385eb3d A	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 .
5b2abdfb	62	.Sh SEE ALSO
9385eb3d A	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 .
5b2abdfb A	73	.Sh HISTORY
5b2abdfb A	74	The
9385eb3d A	75	.Fn btowc
	76	and
	77	.Fn wctob
	78	functions first appeared in
	79	.Fx 5.0 .