fwide(3p) [posix man page]

FWIDE(3P)						     POSIX Programmer's Manual							 FWIDE(3P)

PROLOG

       This  manual page is part of the POSIX Programmer's Manual.  The Linux implementation of this interface may differ (consult the correspond-
       ing Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

NAME

       fwide -- set stream orientation

SYNOPSIS

       #include <stdio.h>
       #include <wchar.h>

       int fwide(FILE *stream, int mode);

DESCRIPTION

       The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here
       and the ISO C standard is unintentional. This volume of POSIX.1-2008 defers to the ISO C standard.

       The  fwide() function shall determine the orientation of the stream pointed to by stream.  If mode is greater than zero, the function first
       attempts to make the stream wide-oriented. If mode is less than zero, the function first attempts to make the stream byte-oriented.  Other-
       wise, mode is zero and the function does not alter the orientation of the stream.

       If the orientation of the stream has already been determined, fwide() shall not change it.

       The fwide() function shall not change the setting of errno if successful.

       Since  no  return  value is reserved to indicate an error, an application wishing to check for error situations should set errno to 0, then
       call fwide(), then check errno, and if it is non-zero, assume an error has occurred.

RETURN VALUE

       The fwide() function shall return a value greater than zero if, after the call, the stream has wide-orientation, a value less than zero	if
       the stream has byte-orientation, or zero if the stream has no orientation.

ERRORS

       The fwide() function may fail if:

       EBADF  The stream argument is not a valid stream.

       The following sections are informative.

EXAMPLES

       None.

APPLICATION USAGE

       A call to fwide() with mode set to zero can be used to determine the current orientation of a stream.

RATIONALE

       None.

FUTURE DIRECTIONS

       None.

SEE ALSO

       The Base Definitions volume of POSIX.1-2008, <stdio.h>, <wchar.h>

COPYRIGHT

       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2013 Edition, Standard for Information Technol-
       ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, Copyright (C)  2013  by	the  Institute	of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
       event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Stan-
       dard is the referee document. The original Standard can be obtained online at http://www.unix.org/online.html .

       Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

IEEE
/The Open Group						       2013								 FWIDE(3P)

Check Out this Related Man Page

fwide(3)						     Library Functions Manual							  fwide(3)

NAME

       fwide - Sets stream orientation to byte or wide-character

LIBRARY

       Standard C Library (libc)

SYNOPSIS

       #include <stdio.h> #include <wchar.h>

       int fwide(
	       FILE *stream,
	       int mode);

STANDARDS

       Interfaces documented on this reference page conform to industry standards as follows:

       fwide(): XSH5.0

       Refer to the standards(5) reference page for more information about industry standards and associated tags.

PARAMETERS

       Points to a FILE structure specifying an open stream Specifies an integer that determines the orientation of the stream.  If the integer is
       greater than zero, the function attempts to make the stream wide-character oriented.  If the  integer  is  less	than  zero,  the  function
       attempts to make the stream byte oriented. If the integer is zero, the function does not attempt to alter the stream orientation.

DESCRIPTION

       The fwide() function, depending on the value of the mode parameter, sets or queries the orientation of a stream of data specified by a FILE
       structure.

       If the stream has no orientation, a positive or negative mode value causes the function to change the stream orientation to wide  character
       or byte, respectively. The function does not change stream orientation when it is already set.  When the stream orientation is already set,
       the application must first call freopen() to reinitialize the stream and then call fwide() to reset the stream orientation.

       A mode value of zero causes the function to return the current stream orientation without attempting to change it.

RETURN VALUES

       The fwide() function returns an integer value to indicate the stream orientation after the call.  The function returns a value greater than
       zero  if the stream orientation is wide-character, a value less than zero if the stream orientation is byte, and 0 (zero) if the stream has
       no orientation.	On error, the function returns 0 (zero) and sets errno to indicate the condition.

ERRORS

       The file descriptor associated with stream is invalid.

RELATED INFORMATION

       Functions:  fopen(3) delim off

																	  fwide(3)

Linux and UNIX Man Pages

fwide(3p) [posix man page]

Check Out this Related Man Page