fgetws - get a wide-character string from a stream
wchar_t *fgetws(wchar_t *restrict ws, int n,
FILE *restrict stream);
[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 IEEE Std 1003.1-2001 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 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().
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, [CX] and shall set errno to indicate the error.
Refer to fgetwc().
fopen(), fread(), the Base Definitions volume of IEEE Std 1003.1-2001, <stdio.h>, <wchar.h>
First released in Issue 4. Derived from the MSE working draft.
The Optional Header (OH) marking is removed from <stdio.h>.
Extensions beyond the ISO C standard are marked.
The prototype for fgetws() is changed for alignment with the ISO/IEC 9899:1999 standard.