Section: Linux Programmer's Manual (3)
Return to Main Contents
fgetws - read a wide-character string from a FILE stream
wchar_t *fgetws(wchar_t *ws, int n, FILE *stream);
function is the wide-character equivalent
It reads a string of at most n-1 wide characters into the
wide-character array pointed to by ws,
and adds a terminating null wide character (L'\0').
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 nonlocking counterpart, see
function, if successful, returns ws.
If end of stream
was already reached or if an error occurred, it returns NULL.
For an explanation of the terms used in this section, see
POSIX.1-2001, POSIX.1-2008, C99.
The behavior of
depends on the
category of the
In the absence of additional information passed to the
call, it is
reasonable to expect that
will actually read a multibyte string
from the stream and then convert it to a wide-character string.
This function is unreliable,
because it does not permit to deal properly with
null wide characters that may be present in the input.
This page is part of release 4.15 of the Linux
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
- RETURN VALUE
- CONFORMING TO
- SEE ALSO
This document was created by
using the manual pages.
Time: 02:05:26 GMT, September 19, 2018