1.\" $OpenBSD: fwide.3,v 1.3 2007/05/31 19:19:31 jmc Exp $ 2.\" 3.\" $NetBSD: fwide.3,v 1.6 2003/09/08 17:54:32 wiz Exp $ 4.\" 5.\" Copyright (c)2001 Citrus Project, 6.\" All rights reserved. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" 29.\" $Citrus: xpg4dl/FreeBSD/lib/libc/stdio/fwide.3,v 1.2 2001/12/07 04:47:08 yamt Exp $ 30.\" 31.Dd $Mdocdate: May 31 2007 $ 32.Dt FWIDE 3 33.Os 34.Sh NAME 35.Nm fwide 36.Nd get/set orientation of a stream 37.Sh SYNOPSIS 38.In stdio.h 39.In wchar.h 40.Ft int 41.Fn fwide "FILE *stream" "int mode" 42.Sh DESCRIPTION 43The 44.Fn fwide 45function 46determines the orientation of the stream pointed at by 47.Fa stream . 48.Pp 49If the orientation of 50.Fa stream 51has already been determined, 52.Fn fwide 53leaves it unchanged. 54Otherwise, 55.Fn fwide 56sets the orientation of 57.Fa stream 58according to 59.Fa mode . 60.Pp 61If 62.Fa mode 63is less than zero, 64.Fa stream 65is set to byte-oriented. 66If it is greater than zero, 67.Fa stream 68is set to wide-oriented. 69Otherwise, 70.Fa mode 71is zero, and 72.Fa stream 73is unchanged. 74.Sh RETURN VALUES 75.Fn fwide 76returns a value according to orientation after the call of 77.Fn fwide ; 78a value less than zero if byte-oriented, a value greater than zero 79if wide-oriented, and zero if the stream has no orientation. 80.Sh SEE ALSO 81.Xr ferror 3 , 82.Xr fgetc 3 , 83.Xr fgetwc 3 , 84.Xr fopen 3 , 85.Xr fputc 3 , 86.Xr fputwc 3 , 87.Xr freopen 3 , 88.Xr stdio 3 89.Sh STANDARDS 90The 91.Fn fwide 92function 93conforms to 94.St -isoC-99 . 95