[apple/libc.git] / stdio / FreeBSD / fwide.3

.\"	$NetBSD: fwide.3,v 1.3 2002/02/07 07:00:25 ross Exp $
.\"
.\" Copyright (c)2001 Citrus Project,
.\" 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.
.\"
.\" $Citrus: xpg4dl/FreeBSD/lib/libc/stdio/fwide.3,v 1.2 2001/12/07 04:47:08 yamt Exp $
.\" $FreeBSD: src/lib/libc/stdio/fwide.3,v 1.3 2002/12/18 12:45:10 ru Exp $
.\"
.Dd October 24, 2001
.Dt FWIDE 3
.Os
.Sh NAME
.Nm fwide
.Nd get/set orientation of a stream
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.In wchar.h
.Ft int
.Fn fwide "FILE *stream" "int mode"
.Sh DESCRIPTION
The
.Fn fwide
function
determines the orientation of the stream pointed at by
.Fa stream .
.Pp
If the orientation of
.Fa stream
has already been determined,
.Fn fwide
leaves it unchanged.
Otherwise,
.Fn fwide
sets the orientation of
.Fa stream
according to
.Fa mode .
.Pp
If
.Fa mode
is less than zero,
.Fa stream
is set to be byte-oriented.
If
.Fa mode
is greater than zero,
.Fa stream
is set to be wide-oriented.
Otherwise,
.Fa mode
is zero, and
.Fa stream
is unchanged.
.Sh RETURN VALUES
The
.Fn fwide
function
returns a value according to orientation after the call of
.Fn fwide ;
a value less than zero if byte-oriented, a value greater than zero
if wide-oriented, and zero if the stream has no orientation.
.Sh SEE ALSO
.Xr ferror 3 ,
.Xr fgetc 3 ,
.Xr fgetwc 3 ,
.Xr fopen 3 ,
.Xr fputc 3 ,
.Xr fputwc 3 ,
.Xr freopen 3 ,
.Xr stdio 3
.Sh STANDARDS
The
.Fn fwide
function
conforms to
.St -isoC-99 .
Commit	Line	Data
9385eb3d	1	.\" $NetBSD: fwide.3,v 1.3 2002/02/07 07:00:25 ross Exp $
5b2abdfb	2	.\"
9385eb3d	3	.\" Copyright (c)2001 Citrus Project,
5b2abdfb A	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	.\"
9385eb3d A	27	.\" $Citrus: xpg4dl/FreeBSD/lib/libc/stdio/fwide.3,v 1.2 2001/12/07 04:47:08 yamt Exp $
9385eb3d A	28	.\" $FreeBSD: src/lib/libc/stdio/fwide.3,v 1.3 2002/12/18 12:45:10 ru Exp $
5b2abdfb	29	.\"
9385eb3d A	30	.Dd October 24, 2001
9385eb3d A	31	.Dt FWIDE 3
5b2abdfb A	32	.Os
5b2abdfb A	33	.Sh NAME
9385eb3d A	34	.Nm fwide
9385eb3d A	35	.Nd get/set orientation of a stream
5b2abdfb A	36	.Sh LIBRARY
	37	.Lb libc
	38	.Sh SYNOPSIS
9385eb3d A	39	.In stdio.h
9385eb3d A	40	.In wchar.h
5b2abdfb	41	.Ft int
9385eb3d	42	.Fn fwide "FILE *stream" "int mode"
5b2abdfb	43	.Sh DESCRIPTION
9385eb3d A	44	The
	45	.Fn fwide
	46	function
	47	determines the orientation of the stream pointed at by
	48	.Fa stream .
5b2abdfb	49	.Pp
9385eb3d A	50	If the orientation of
	51	.Fa stream
	52	has already been determined,
	53	.Fn fwide
	54	leaves it unchanged.
	55	Otherwise,
	56	.Fn fwide
	57	sets the orientation of
	58	.Fa stream
	59	according to
	60	.Fa mode .
5b2abdfb	61	.Pp
9385eb3d A	62	If
	63	.Fa mode
	64	is less than zero,
	65	.Fa stream
ad3c9f2a A	66	is set to be byte-oriented.
	67	If
	68	.Fa mode
	69	is greater than zero,
9385eb3d	70	.Fa stream
ad3c9f2a	71	is set to be wide-oriented.
9385eb3d A	72	Otherwise,
	73	.Fa mode
	74	is zero, and
	75	.Fa stream
	76	is unchanged.
	77	.Sh RETURN VALUES
	78	The
	79	.Fn fwide
	80	function
	81	returns a value according to orientation after the call of
	82	.Fn fwide ;
	83	a value less than zero if byte-oriented, a value greater than zero
	84	if wide-oriented, and zero if the stream has no orientation.
5b2abdfb	85	.Sh SEE ALSO
9385eb3d A	86	.Xr ferror 3 ,
	87	.Xr fgetc 3 ,
	88	.Xr fgetwc 3 ,
	89	.Xr fopen 3 ,
	90	.Xr fputc 3 ,
	91	.Xr fputwc 3 ,
	92	.Xr freopen 3 ,
	93	.Xr stdio 3
	94	.Sh STANDARDS
5b2abdfb	95	The
9385eb3d A	96	.Fn fwide
	97	function
	98	conforms to
	99	.St -isoC-99 .