2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
|
.\"
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" References consulted:
|
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
|
|
|
|
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
|
|
|
|
|
.\" ISO/IEC 9899:1999
|
|
|
|
|
.\"
|
|
|
|
|
.\" Modified Tue Oct 16 23:18:40 BST 2001 by John Levon <moz@compsoc.man.ac.uk>
|
|
|
|
|
.TH FGETWS 3 1999-07-25 "GNU" "Linux Programmer's Manual"
|
|
|
|
|
.SH NAME
|
2007-04-24 19:40:35 +00:00
|
|
|
fgetws \- read a wide-character string from a FILE stream
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
.B #include <wchar.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "wchar_t *fgetws(wchar_t *" ws ", int " n ", FILE *" stream );
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR fgetws ()
|
|
|
|
|
function is the wide-character equivalent
|
|
|
|
|
of the
|
|
|
|
|
.BR fgets ()
|
|
|
|
|
function.
|
2007-04-12 22:42:49 +00:00
|
|
|
It reads a string of at most \fIn-1\fP wide characters into the
|
2004-11-03 13:51:07 +00:00
|
|
|
wide-character array pointed to by \fIws\fP, and adds a terminating L'\\0'
|
2007-04-12 22:42:49 +00:00
|
|
|
character.
|
|
|
|
|
It stops reading wide characters after it has encountered and
|
|
|
|
|
stored a newline wide character.
|
|
|
|
|
It also stops when end of stream is reached.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
|
The programmer must ensure that there is room for at least \fIn\fP wide
|
|
|
|
|
characters at \fIws\fP.
|
|
|
|
|
.PP
|
|
|
|
|
For a non-locking counterpart, see
|
|
|
|
|
.BR unlocked_stdio (3).
|
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR fgetws ()
|
|
|
|
|
function, if successful, returns \fIws\fP.
|
2007-04-12 22:42:49 +00:00
|
|
|
If end of stream
|
2004-11-03 13:51:07 +00:00
|
|
|
was already reached or if an error occurred, it returns NULL.
|
|
|
|
|
.SH "CONFORMING TO"
|
2006-08-04 09:41:28 +00:00
|
|
|
C99, POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
2007-05-12 09:06:04 +00:00
|
|
|
The behaviour of
|
|
|
|
|
.BR fgetws ()
|
|
|
|
|
depends on the LC_CTYPE category of the
|
2004-11-03 13:51:07 +00:00
|
|
|
current locale.
|
|
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
In the absence of additional information passed to the
|
2007-05-12 00:30:29 +00:00
|
|
|
.BR fopen (3)
|
2005-10-20 15:11:10 +00:00
|
|
|
call, it is
|
2007-05-12 09:06:04 +00:00
|
|
|
reasonable to expect that
|
|
|
|
|
.BR fgetws ()
|
2007-04-24 19:06:06 +00:00
|
|
|
will actually read a multibyte string
|
2007-04-24 19:40:35 +00:00
|
|
|
from the stream and then convert it to a wide-character string.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-04-24 19:06:06 +00:00
|
|
|
This function is unreliable,
|
|
|
|
|
because it does not permit to deal properly with
|
2004-11-03 13:51:07 +00:00
|
|
|
null wide characters that may be present in the input.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR fgetwc (3),
|
|
|
|
|
.BR unlocked_stdio (3)
|
