FGETWS(3) Library Functions Manual FGETWS(3)

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

[CX] 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-2024 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.

[CX] 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(3), fgetws (), fwscanf(3), getwc(3), getwchar(3), vfwscanf(3), vwscanf(3), or wscanf(3) using stream that returns data not supplied by a prior call to ungetwc(3).

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 an error occurs, the error indicator for the stream shall be set, and fgetws () shall return a null pointer [CX] and shall set errno to indicate the error.