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

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