*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> fgetws (3)              



NAME    [Toc]    [Back]

       fgetws - read a wide character string from a FILE stream

SYNOPSIS    [Toc]    [Back]

       #include <wchar.h>

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

DESCRIPTION    [Toc]    [Back]

       The fgetws function is the wide-character equivalent of the fgets function.
 It reads a string of at most n-1 wide characters into  the  widecharacter
  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

       The programmer must ensure that there is room for at least n wide characters
 at ws.

RETURN VALUE    [Toc]    [Back]

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

CONFORMING TO    [Toc]    [Back]

       ISO/ANSI C, UNIX98

SEE ALSO    [Toc]    [Back]


NOTES    [Toc]    [Back]

       The behaviour of fgetws depends on the LC_CTYPE category of the current

       In  the	absence of additional information passed to the fopen 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.

GNU				  1999-07-25			     FGETWS(3)
[ Back ]
 Similar pages
Name OS Title
fgetwc Linux read a wide character from a FILE stream
fputws Linux write a wide character string to a FILE stream
fputws Tru64 Write a wide-character string to a stream
fputwc Linux write a wide character to a FILE stream
ungetwc Linux push back a wide character onto a FILE stream
mbsrtowcs NetBSD converts a multibyte character string to a wide character string (restartable)
wcsrtombs NetBSD converts a wide character string to a multibyte character string (restartable)
wcsspn Linux advance in a wide-character string, skipping any of a set of wide characters
getwchar Linux read a wide character from standard input
wcspbrk Linux search a wide-character string for any of a set of wide characters
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service