|
Packit |
7cfc04 |
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
|
|
Packit |
7cfc04 |
.\" This is free documentation; you can redistribute it and/or
|
|
Packit |
7cfc04 |
.\" modify it under the terms of the GNU General Public License as
|
|
Packit |
7cfc04 |
.\" published by the Free Software Foundation; either version 2 of
|
|
Packit |
7cfc04 |
.\" the License, or (at your option) any later version.
|
|
Packit |
7cfc04 |
.\" %%%LICENSE_END
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.\" References consulted:
|
|
Packit |
7cfc04 |
.\" GNU glibc-2 source code and manual
|
|
Packit |
7cfc04 |
.\" Dinkumware C library reference http://www.dinkumware.com/
|
|
Packit |
7cfc04 |
.\" OpenGroup's Single UNIX specification
|
|
Packit |
7cfc04 |
.\" http://www.UNIX-systems.org/online.html
|
|
Packit |
7cfc04 |
.\" ISO/IEC 9899:1999
|
|
Packit |
7cfc04 |
.\"
|
|
Packit |
7cfc04 |
.\" Modified Tue Oct 16 23:18:40 BST 2001 by John Levon <moz@compsoc.man.ac.uk>
|
|
Packit |
7cfc04 |
.TH FGETWS 3 2015-08-08 "GNU" "Linux Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
fgetws \- read a wide-character string from a FILE stream
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
.B #include <wchar.h>
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
.BI "wchar_t *fgetws(wchar_t *" ws ", int " n ", FILE *" stream );
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.BR fgetws ()
|
|
Packit |
7cfc04 |
function is the wide-character equivalent
|
|
Packit |
7cfc04 |
of the
|
|
Packit |
7cfc04 |
.BR fgets (3)
|
|
Packit |
7cfc04 |
function.
|
|
Packit |
7cfc04 |
It reads a string of at most \fIn\-1\fP wide characters into the
|
|
Packit |
7cfc04 |
wide-character array pointed to by \fIws\fP,
|
|
Packit |
7cfc04 |
and adds a terminating null wide character (L\(aq\\0\(aq).
|
|
Packit |
7cfc04 |
It stops reading wide characters after it has encountered and
|
|
Packit |
7cfc04 |
stored a newline wide character.
|
|
Packit |
7cfc04 |
It also stops when end of stream is reached.
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
The programmer must ensure that there is room for at least \fIn\fP wide
|
|
Packit |
7cfc04 |
characters at \fIws\fP.
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
For a nonlocking counterpart, see
|
|
Packit |
7cfc04 |
.BR unlocked_stdio (3).
|
|
Packit |
7cfc04 |
.SH RETURN VALUE
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.BR fgetws ()
|
|
Packit |
7cfc04 |
function, if successful, returns \fIws\fP.
|
|
Packit |
7cfc04 |
If end of stream
|
|
Packit |
7cfc04 |
was already reached or if an error occurred, it returns NULL.
|
|
Packit |
7cfc04 |
.SH ATTRIBUTES
|
|
Packit |
7cfc04 |
For an explanation of the terms used in this section, see
|
|
Packit |
7cfc04 |
.BR attributes (7).
|
|
Packit |
7cfc04 |
.TS
|
|
Packit |
7cfc04 |
allbox;
|
|
Packit |
7cfc04 |
lb lb lb
|
|
Packit |
7cfc04 |
l l l.
|
|
Packit |
7cfc04 |
Interface Attribute Value
|
|
Packit |
7cfc04 |
T{
|
|
Packit |
7cfc04 |
.BR fgetws ()
|
|
Packit |
7cfc04 |
T} Thread safety MT-Safe
|
|
Packit |
7cfc04 |
.TE
|
|
Packit |
7cfc04 |
.SH CONFORMING TO
|
|
Packit |
7cfc04 |
POSIX.1-2001, POSIX.1-2008, C99.
|
|
Packit |
7cfc04 |
.SH NOTES
|
|
Packit |
7cfc04 |
The behavior of
|
|
Packit |
7cfc04 |
.BR fgetws ()
|
|
Packit |
7cfc04 |
depends on the
|
|
Packit |
7cfc04 |
.B LC_CTYPE
|
|
Packit |
7cfc04 |
category of the
|
|
Packit |
7cfc04 |
current locale.
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
In the absence of additional information passed to the
|
|
Packit |
7cfc04 |
.BR fopen (3)
|
|
Packit |
7cfc04 |
call, it is
|
|
Packit |
7cfc04 |
reasonable to expect that
|
|
Packit |
7cfc04 |
.BR fgetws ()
|
|
Packit |
7cfc04 |
will actually read a multibyte string
|
|
Packit |
7cfc04 |
from the stream and then convert it to a wide-character string.
|
|
Packit |
7cfc04 |
.PP
|
|
Packit |
7cfc04 |
This function is unreliable,
|
|
Packit |
7cfc04 |
because it does not permit to deal properly with
|
|
Packit |
7cfc04 |
null wide characters that may be present in the input.
|
|
Packit |
7cfc04 |
.SH SEE ALSO
|
|
Packit |
7cfc04 |
.BR fgetwc (3),
|
|
Packit |
7cfc04 |
.BR unlocked_stdio (3)
|
|
Packit |
7cfc04 |
.SH COLOPHON
|
|
Packit |
7cfc04 |
This page is part of release 4.15 of the Linux
|
|
Packit |
7cfc04 |
.I man-pages
|
|
Packit |
7cfc04 |
project.
|
|
Packit |
7cfc04 |
A description of the project,
|
|
Packit |
7cfc04 |
information about reporting bugs,
|
|
Packit |
7cfc04 |
and the latest version of this page,
|
|
Packit |
7cfc04 |
can be found at
|
|
Packit |
7cfc04 |
\%https://www.kernel.org/doc/man\-pages/.
|