|FGETWS(3)||FreeBSD Library Functions Manual||FGETWS(3)|
NAMEfgetws — get a line of wide characters from a stream
LIBRARYStandard C Library (libc, -lc)
SYNOPSIS#include < stdio.h>
#include < wchar.h>
fgetws( wchar_t * restrict ws, int n, FILE * restrict fp);
DESCRIPTIONThe 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 character string ws. Reading stops when a newline character is found, at end-of-file or error. The newline, if any, is retained. If any characters are read and there is no error, a ‘
\0’ character is appended to end the string.
RETURN VALUESUpon 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.
ERRORSThe 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.
STANDARDSThe fgetws() function conforms to IEEE Std 1003.1-2001 (“POSIX.1”).
|August 6, 2002||FreeBSD|