man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

fwide(3C)

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 0, the function first attempts to make the stream wide-orientated. If mode is less than 0, the function first attempts to make the stream byte-orientated. Otherwise, mode is 0 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 Values

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

Errors

The fwide() function may fail if:

EBADF

The stream argument is not a valid stream.

Usage

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

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe
Standard

See Also

attributes(5), standards(5)