Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

fgetws(3) [freebsd man page]

FGETWS(3)						   BSD Library Functions Manual 						 FGETWS(3)

NAME
fgetws -- get a line of wide characters from a stream LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <stdio.h> #include <wchar.h> wchar_t * fgetws(wchar_t * restrict ws, int n, FILE * restrict fp); DESCRIPTION
The fgetws() function reads at most one less than the number of characters specified by n from the given fp and stores them in the wide char- acter string ws. Reading stops when a newline character is found, at end-of-file or error. The newline, if any, is retained. If any char- acters are read and there is no error, a '' character is appended to end the string. RETURN VALUES
Upon successful completion, fgetws() returns ws. If end-of-file occurs before any characters are read, fgetws() returns NULL and the buffer contents remain unchanged. If an error occurs, fgetws() returns NULL and the buffer contents are indeterminate. The fgetws() function does not distinguish between end-of-file and error, and callers must use feof(3) and ferror(3) to determine which occurred. ERRORS
The fgetws() function will fail if: [EBADF] The given fp argument is not a readable stream. [EILSEQ] The data obtained from the input stream does not form a valid multibyte character. The function fgetws() may also fail and set errno for any of the errors specified for the routines fflush(3), fstat(2), read(2), or malloc(3). SEE ALSO
feof(3), ferror(3), fgets(3) STANDARDS
The fgetws() function conforms to IEEE Std 1003.1-2001 (``POSIX.1''). BSD
August 6, 2002 BSD

Check Out this Related Man Page

FGETWS(3)						     Linux Programmer's Manual							 FGETWS(3)

NAME
fgetws - read a wide-character string from a FILE stream SYNOPSIS
#include <wchar.h> wchar_t *fgetws(wchar_t *ws, int n, FILE *stream); DESCRIPTION
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''). 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
The fgetws() function, if successful, returns ws. If end of stream was already reached or if an error occurred, it returns NULL. ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7). +----------+---------------+---------+ |Interface | Attribute | Value | +----------+---------------+---------+ |fgetws() | Thread safety | MT-Safe | +----------+---------------+---------+ CONFORMING TO
POSIX.1-2001, POSIX.1-2008, C99. NOTES
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 multi- byte 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
fgetwc(3), unlocked_stdio(3) COLOPHON
This page is part of release 4.15 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/. GNU
2015-08-08 FGETWS(3)
Man Page