NAME
fwide — set stream
orientation
SYNOPSIS
#include <stdio.h>
#include <wchar.h>
int fwide(FILE *stream, int mode);
DESCRIPTION
[CX] 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-2017 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. Otherwise,
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.
[CX] 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]
- [CX] The stream argument is not a valid stream.
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
CHANGE HISTORY
First released in Issue 5. Included for alignment with ISO/IEC 9899/AMD1:1995 (“ISO C90, Amendment 1”) (E).
Issue 6
Extensions beyond the ISO C standard are marked.
Issue 7
POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0225 [272] is applied.