FGETWSSection: Linux Programmer's Manual (3)
Index Return to Main Contents
NAMEfgetws - read a wide-character string from a FILE stream
#include <wchar.h> wchar_t *fgetws(wchar_t *ws, int n, FILE *stream);
DESCRIPTIONThe fgetws() function is the wide-character equivalent of the fgets(3) function. It reads a string of at most n-1 wide characters into the wide-character array pointed to by ws, and adds a terminating L'\0' character. It stops reading wide characters after it has encountered and stored a newline wide character. It also stops when end of stream is reached.
The programmer must ensure that there is room for at least n wide characters at ws.
For a non-locking counterpart, see unlocked_stdio(3).
RETURN VALUEThe fgetws() function, if successful, returns ws. If end of stream was already reached or if an error occurred, it returns NULL.
CONFORMING TOC99, POSIX.1-2001.
NOTESThe behavior of fgetws() depends on the LC_CTYPE category of the current locale.
In the absence of additional information passed to the fopen(3) call, it is reasonable to expect that fgetws() will actually read a multibyte string from the stream and then convert it to a wide-character string.
SEE ALSOfgetwc(3), unlocked_stdio(3)
COLOPHONThis page is part of release 3.21 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.