The Open Group Base Specifications Issue 6
IEEE Std 1003.1, 2004 Edition
Copyright © 2001-2004 The IEEE and The Open Group, All Rights reserved.

NAME

fgetws - get a wide-character string from a stream

SYNOPSIS

#include <stdio.h>
#include <wchar.h>

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

DESCRIPTION

[CX] [Option Start] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to the ISO C standard. [Option End]

The fgetws() function shall read characters from the stream, convert these to the corresponding wide-character codes, place them in the wchar_t array pointed to by ws, until n-1 characters are read, or a <newline> is read, converted, and transferred to ws, or an end-of-file condition is encountered. The wide-character string, ws, shall then be terminated with a null wide-character code.

If an error occurs, the resulting value of the file position indicator for the stream is unspecified.

[CX] [Option Start] The fgetws() function may mark the st_atime field of the file associated with stream for update. The st_atime field shall be marked for update by the first successful execution of fgetc(), fgets(), fgetwc(), fgetws(), fread(), fscanf(), getc(), getchar(), gets(), or scanf() using stream that returns data not supplied by a prior call to ungetc() or ungetwc(). [Option End]

RETURN VALUE

Upon successful completion, fgetws() shall return ws. If the stream is at end-of-file, the end-of-file indicator for the stream shall be set and fgetws() shall return a null pointer. If a read error occurs, the error indicator for the stream shall be set, fgetws() shall return a null pointer, [CX] [Option Start]  and shall set errno to indicate the error. [Option End]

ERRORS

Refer to fgetwc().


The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

fopen(), fread(), the Base Definitions volume of IEEE Std 1003.1-2001, <stdio.h>, <wchar.h>

CHANGE HISTORY

First released in Issue 4. Derived from the MSE working draft.

Issue 5

The Optional Header (OH) marking is removed from <stdio.h>.

Issue 6

Extensions beyond the ISO C standard are marked.

The prototype for fgetws() is changed for alignment with the ISO/IEC 9899:1999 standard.

End of informative text.

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
[ Main Index | XBD | XCU | XSH | XRAT ]