Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

fgetws(3) [osx man page]

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

NAME
fgetws, fgetws_l -- 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 stream); #include <stdio.h> #include <wchar.h> #include <xlocale.h> wchar_t * fgetws_l(wchar_t *restrict ws, int n, FILE *restrict stream, locale_t loc); DESCRIPTION
The fgetws() function reads at most one less than the number of characters specified by n from the given stream 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 '' character is appended to end the string. While the fgetws() function uses the current locale, the fgetws_l() function may be passed a locale directly. See xlocale(3) for more infor- mation. 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; callers must use feof(3) and ferror(3) to determine which occurred. ERRORS
The fgetws() function will fail if: [EBADF] The given stream 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), xlocale(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

getws(3C)						   Standard C Library Functions 						 getws(3C)

NAME
getws, fgetws - get a wide-character string from a stream SYNOPSIS
#include <stdio.h> include <widec.h> wchar_t *getws(wchar_t *ws); #include <stdio.h> include <wchar.h> wchar_t *fgetws(wchar_t *restrict ws, int n, FILE *restrict stream); DESCRIPTION
The getws() function reads a string of characters from the standard input stream, stdin, converts these characters to the corresponding wide-character codes, and writes them to the array pointed to by ws, until a newline character is read, converted and transferred to ws or an end-of-file condition is encountered. The wide-character string, ws, is then terminated with a null wide-character code. The fgetws() function reads characters from the stream, converts them to the corresponding wide-character codes, and places them in the wchar_t array pointed to by ws until n-1 characters are read, or until a newline character is read, converted and transferred to ws, or an end-of-file condition is encountered. The wide-character string, ws, is then terminated with a null wide-character code. If an error occurs, the resulting value of the file position indicator for the stream is indeterminate. The fgetws() function may mark the st_atime field of the file associated with stream for update. The st_atime field will be marked for update by the first successful execution of fgetc(3C), fgets(3C), fgetwc(3C), fgetws(), fread(3C), fscanf(3C), getc(3C), getchar(3C), gets(3C), or scanf(3C) using stream that returns data not supplied by a prior call to ungetc(3C) or ungetwc(3C). RETURN VALUES
Upon successful completion, getws() and fgetws() return ws. If the stream is at end-of-file, the end-of-file indicator for the stream is set and fgetws() returns a null pointer. For standard-conforming (see standards(5)) applications, if the end-of-file indicator for the stream is set, fgetws() returns a null pointer whether or not the stream is at end-of-file. If a read error occurs, the error indicator for the stream is set and fgetws() returns a null pointer and sets errno to indicate the error. ERRORS
See fgetwc(3C) for the conditions that will cause fgetws() to fail. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |fgetws() is Standard. | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
ferror(3C), fgetwc(3C), fread(3C), getwc(3C), putws(3C), scanf(3C), ungetc(3C), ungetwc(3C)attributes(5), standards(5) SunOS 5.11 15 Oct 2003 getws(3C)
Man Page