diff options
Diffstat (limited to 'man3/fgetwc.3')
| -rw-r--r-- | man3/fgetwc.3 | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/man3/fgetwc.3 b/man3/fgetwc.3 index 948c967c7e..5f7c66598f 100644 --- a/man3/fgetwc.3 +++ b/man3/fgetwc.3 @@ -26,15 +26,22 @@ fgetwc, getwc \- read a wide character from a FILE stream .BI "wint_t getwc(FILE *" stream ); .fi .SH DESCRIPTION -The \fBfgetwc\fP() function is the wide-character equivalent -of the \fBfgetc\fP() function. +The +.BR fgetwc () +function is the wide-character equivalent +of the +.BR fgetc () +function. It reads a wide character from \fIstream\fP and returns it. If the end of stream is reached, or if \fIferror(stream)\fP becomes true, it returns WEOF. If a wide-character conversion error occurs, it sets \fIerrno\fP to \fBEILSEQ\fP and returns WEOF. .PP -The \fBgetwc\fP() function or macro functions identically to \fBfgetwc\fP(). +The +.BR getwc () +function or macro functions identically to +.BR fgetwc (). It may be implemented as a macro, and may evaluate its argument more than once. There is no reason ever to use it. @@ -42,7 +49,9 @@ There is no reason ever to use it. For non-locking counterparts, see .BR unlocked_stdio (3). .SH "RETURN VALUE" -The \fBfgetwc\fP() function returns the next wide-character +The +.BR fgetwc () +function returns the next wide-character from the stream, or WEOF. .SH ERRORS Apart from the usual ones, there is @@ -53,13 +62,16 @@ form a valid character. .SH "CONFORMING TO" C99, POSIX.1-2001. .SH NOTES -The behaviour of \fBfgetwc\fP() depends on the LC_CTYPE category of the +The behaviour of +.BR fgetwc () +depends on the LC_CTYPE category of the current locale. .PP In the absence of additional information passed to the .BR fopen (3) call, it is -reasonable to expect that \fBfgetwc\fP() +reasonable to expect that +.BR fgetwc () will actually read a multibyte sequence from the stream and then convert it to a wide character. .SH "SEE ALSO" |