lib/libc/stdio/fwide.3

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