logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface

Application Usage

       None.

Description

       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  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 last data access timestamp of the  file  associated  with  stream  for
       update.  The  last  data access timestamp shall be marked for update by the first successful execution of
       fgetwc(), fgetws(), fwscanf(), getwc(), getwchar(), vfwscanf(), vwscanf(), or wscanf() using stream  that
       returns data not supplied by a prior call to ungetwc().

Errors

       Refer to fgetwc().

       Thefollowingsectionsareinformative.

Examples

       None.

Future Directions

       None.

Name

       fgetws — get a wide-character string from a stream

Prolog

       This  manual  page  is part of the POSIX Programmer's Manual.  The Linux implementation of this interface
       may differ (consult the corresponding Linux manual page for details of Linux behavior), or the  interface
       may not be implemented on Linux.

Rationale

       None.

Return Value

       Upon  successful  completion,  fgetws()  shall return ws.  If the end-of-file indicator for the stream is
       set, or 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.

See Also

Section2.5, StandardI/OStreams, fopen(), fread()

       The Base Definitions volume of POSIX.1‐2017, <stdio.h>, <wchar.h>

Synopsis

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

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

See Also