NAME

       fgetws - get a wide-character string from a stream

SYNOPSIS

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

       wchar_t *fgetws(wchar_t *restrict ws, int n,
              FILE *restrict stream);

DESCRIPTION

       The  fgetws()  function  shall  read  characters  from  the  stream,  convert these to the
       corresponding wide-character codes, place them in the wchar_t  array  pointed  to  by  ws,
       until  n-1  characters are read, or a <newline> is read, converted, and transferred to ws,
       or an end-of-file condition is encountered. The wide-character string, ws, shall  then  be
       terminated with a null wide-character code.

       If  an  error occurs, the resulting value of the file position indicator for the stream is
       unspecified.

       The fgetws() function may mark the st_atime field of the file associated with  stream  for
       update. The st_atime field shall be marked for update by the first successful execution of
       fgetc(), fgets(), fgetwc(), fgetws(), fread(), fscanf(),  getc(),  getchar(),  gets(),  or
       scanf()  using  stream  that  returns  data  not  supplied  by a prior call to ungetc() or
       ungetwc().

RETURN VALUE

       Upon successful completion, fgetws() shall return ws.  If the stream  is  at  end-of-file,
       the  end-of-file  indicator  for  the stream shall be set and fgetws() shall return a null
       pointer. If a read error occurs, the error indicator for the stream shall be set, fgetws()
       shall return a null pointer,  and shall set errno to indicate the error.

ERRORS

       Refer to fgetwc() .

       The following sections are informative.

EXAMPLES

       None.

APPLICATION USAGE

       None.

RATIONALE

       None.

FUTURE DIRECTIONS

       None.

SEE ALSO

       fopen()  ,  fread()  ,  the  Base  Definitions  volume of IEEE Std 1003.1-2001, <stdio.h>,
       <wchar.h>

COPYRIGHT

       Portions of this text are reprinted and  reproduced  in  electronic  form  from  IEEE  Std
       1003.1,  2003  Edition,  Standard  for Information Technology -- Portable Operating System
       Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003  by
       the  Institute  of  Electrical  and  Electronics Engineers, Inc and The Open Group. 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 Standard is the referee document. The
       original Standard can be obtained online at http://www.opengroup.org/unix/online.html .