NAME

fwide - set stream orientation

 SYNOPSIS

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

int fwide(FILE *stream, int mode);

 DESCRIPTION

The fwide() function determines the orientation of the stream pointed to by stream. If mode is greater than zero, the function first attempts to make the stream wide-orientated. If mode is less than zero, the function first attempts to make the stream byte-orientated. 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() does not change it.

Because 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 returns 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.

 EXAMPLES

None.

 APPLICATION USAGE

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

 FUTURE DIRECTIONS

None.

 SEE ALSO

<wchar.h>.

DERIVATION

Derived from the ISO/IEC 9899:1990/Amendment 1:1995 (E).