fgetwln(3) [mojave man page]

FGETWLN(3)						   BSD Library Functions Manual 						FGETWLN(3)

NAME

     fgetwln, fgetwln_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 *
     fgetwln(FILE * restrict stream, size_t * restrict len);

     #include <xlocale.h>

     wchar_t *
     fgetwln_l(FILE * restrict stream, size_t * restrict len, locale_t loc);

DESCRIPTION

     The fgetwln() function returns a pointer to the next line from the stream referenced by stream.  This line is not a standard wide character
     string as it does not end with a terminating null wide character.	The length of the line, including the final newline, is stored in the mem-
     ory location to which len points.	(Note, however, that if the line is the last in a file that does not end in a newline, the returned text
     will not contain a newline.)

     While the fgetwln() function uses the current locale, the fgetwln_l() function may be passed a locale directly. See xlocale(3) for more
     information.

RETURN VALUES

     Upon successful completion a pointer is returned; this pointer becomes invalid after the next I/O operation on stream (whether successful or
     not) or as soon as the stream is closed.  Otherwise, NULL is returned.  The fgetwln() function does not distinguish between end-of-file and
     error; the routines feof(3) and ferror(3) must be used to determine which occurred.  If an error occurs, the global variable errno is set to
     indicate the error.  The end-of-file condition is remembered, even on a terminal, and all subsequent attempts to read will return NULL until
     the condition is cleared with clearerr(3).

     The text to which the returned pointer points may be modified, provided that no changes are made beyond the returned size.  These changes are
     lost as soon as the pointer becomes invalid.

ERRORS

     [EBADF]		The argument stream is not a stream open for reading.

     The fgetwln() function may also fail and set errno for any of the errors specified for the routines mbrtowc(3), realloc(3), or read(2).

SEE ALSO

     ferror(3), fgetln(3), fgetws(3), fopen(3), xlocale(3)

BSD
								   July 16, 2004							       BSD

Check Out this Related 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

Linux and UNIX Man Pages

fgetwln(3) [mojave man page]

Check Out this Related Man Page