Index for Section 3

Alphabetical listing for F

Bottom of page

fwide(3)
NAME
  fwide - Set stream orientation to byte or wide-character

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

  int fwide(
	  FILE *stream,
	   int mode );

LIBRARY
  Standard C Library (libc)

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
  *stream
      Points to a FILE structure specifying an open stream

  *mode
      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
  [EBADF]
      The file descriptor associated with stream is invalid.

SEE ALSO
  Functions: fopen(3)

Index for Section 3

Alphabetical listing for F

Top of page