lib/libc/stdio/fwide.3

   1 .\"     $NetBSD: fwide.3,v 1.6 2003/09/08 17:54:32 wiz Exp $
   2 .\"
   3 .\" Copyright (c)2001 Citrus Project,
   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 .\"
  27 .\" $Citrus: xpg4dl/FreeBSD/lib/libc/stdio/fwide.3,v 1.2 2001/12/07 04:47:08 yamt Exp $
  28 .\"
  29 .Dd October 24, 2001
  30 .Dt FWIDE 3
  31 .Os
  32 .Sh NAME
  33 .Nm fwide
  34 .Nd get/set orientation of a stream
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In stdio.h
  39 .In wchar.h
  40 .Ft int
  41 .Fn fwide "FILE *stream" "int mode"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn fwide
  45 function
  46 determines the orientation of the stream pointed at by
  47 .Fa stream .
  48 .Pp
  49 If the orientation of
  50 .Fa stream
  51 has already been determined,
  52 .Fn fwide
  53 leaves it unchanged.
  54 Otherwise,
  55 .Fn fwide
  56 sets the orientation of
  57 .Fa stream
  58 according to
  59 .Fa mode .
  60 .Pp
  61 If
  62 .Fa mode
  63 is less than zero,
  64 .Fa stream
  65 is set to byte-oriented.
  66 If it is greater than zero,
  67 .Fa stream
  68 is set to wide-oriented.
  69 Otherwise,
  70 .Fa mode
  71 is zero, and
  72 .Fa stream
  73 is unchanged.
  74 .Sh RETURN VALUES
  75 .Fn fwide
  76 returns a value according to orientation after the call of
  77 .Fn fwide ;
  78 a value less than zero if byte-oriented, a value greater than zero
  79 if 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
  90 The
  91 .Fn fwide
  92 function
  93 conforms to
  94 .St -isoC-99 .