stdio/fwide.3

   1 .\"     $NetBSD: fwide.3,v 1.3 2002/02/07 07:00:25 ross 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 .\" $FreeBSD: src/lib/libc/stdio/fwide.3,v 1.3 2002/12/18 12:45:10 ru 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 be byte-oriented.
  67 If
  68 .Fa mode
  69 is greater than zero,
  70 .Fa stream
  71 is set to be wide-oriented.
  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.
  85 .Sh SEE ALSO
  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
  95 The
  96 .Fn fwide
  97 function
  98 conforms to
  99 .St -isoC-99 .