usr/src/man/man3c/fwide.3c

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH FWIDE 3C "Jun 3, 2015"
  11 .SH NAME
  12 fwide \- set stream orientation
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17 #include <wchar.h>
  18
  19 \fBint\fR \fBfwide\fR(\fBFILE *\fR\fIstream\fR, \fBint\fR \fImode\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .LP
  24 The \fBfwide()\fR function determines the orientation of the stream pointed to
  25 by \fIstream\fR. If \fImode\fR is greater than 0, the function first attempts
  26 to make the stream wide-oriented.  If \fImode\fR is less than 0, the function
  27 first attempts to make the stream byte-oriented.  Otherwise, \fImode\fR is 0
  28 and the function does not alter the orientation of the stream.
  29 .sp
  30 .LP
  31 If the orientation of the stream has already been determined, \fBfwide()\fR
  32 does not change it.
  33 .sp
  34 .LP
  35 Because no return value is reserved to indicate an error, an application
  36 wishing to check for error situations should set \fBerrno\fR to 0, then call
  37 \fBfwide()\fR, then check \fBerrno\fR and if it is non-zero, assume an error
  38 has occurred.
  39 .SH RETURN VALUES
  40 .LP
  41 The \fBfwide()\fR function returns a value greater than 0 if, after the call,
  42 the stream has wide-orientation, a value less than 0 if the stream has
  43 byte-orientation, or 0 if the stream has no orientation.
  44 .SH ERRORS
  45 .LP
  46 The \fBfwide()\fR function may fail if:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBEBADF\fR\fR
  51 .ad
  52 .RS 9n
  53 The \fIstream\fR argument is not a valid stream.
  54 .RE
  55
  56 .SH USAGE
  57 .LP
  58 A call to \fBfwide()\fR with  \fImode\fR set to 0 can be used to determine the
  59 current orientation of a stream.
  60 .SH ATTRIBUTES
  61 .LP
  62 See \fBattributes\fR(5) for descriptions of the following attributes:
  63 .sp
  64
  65 .sp
  66 .TS
  67 box;
  68 c | c
  69 l | l .
  70 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  71 _
  72 Interface Stability     Standard
  73 _
  74 MT-Level        MT-Safe
  75 .TE
  76
  77 .SH SEE ALSO
  78 .LP
  79 \fBattributes\fR(5), \fBstandards\fR(5)