fgetws(3) — Linux manual page

fgetws(3)                Library Functions Manual               fgetws(3)

NAME         top

       fgetws - read a wide-character string from a FILE stream

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <wchar.h>

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

DESCRIPTION         top

       The 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 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 unlocked_stdio(3).

RETURN VALUE         top

       The fgetws() function, if successful, returns ws.  If end of
       stream was already reached or if an error occurred, it returns
       NULL.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌──────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                            │ Attribute     │ Value   │
       ├──────────────────────────────────────┼───────────────┼─────────┤
       │ fgetws()                             │ Thread safety │ MT-Safe │
       └──────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       C11, POSIX.1-2008.

HISTORY         top

       POSIX.1-2001, C99.

NOTES         top

       The 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.

       This function is unreliable, because it does not permit to deal
       properly with null wide characters that may be present in the
       input.

SEE ALSO         top

       fgetwc(3), unlocked_stdio(3)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.15.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2025-08-11.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.15            2025-06-28                      fgetws(3)

Pages that refer to this page: fgetc(3),  fgetwc(3),  gets(3)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.