Penguin
Recent Changes
Annotated edit history of fgetws(3) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 FGETWS
2 !!!FGETWS
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 RETURN VALUE
7 CONFORMING TO
8 SEE ALSO
9 NOTES
10 ----
11 !!NAME
12
13
14 fgetws - read a wide character string from a FILE stream
15 !!SYNOPSIS
16
17
18 __#include
19 __''ws''__, int__ ''n''__, FILE *__''stream''__);
20 __
21 !!DESCRIPTION
22
23
24 The __fgetws__ function is the wide-character equivalent
25 of the __fgets__ function. It reads a string of at most
26 ''n-1'' wide characters into the wide-character array
27 pointed to by ''ws'', and adds a terminating L'0'
28 character. It stops reading wide characters after it has
29 encountered and stored a newline wide character. It also
30 stops when end of stream is reached.
31
32
33 The programmer must ensure that there is room for at least
34 ''n'' wide characters at ''ws''.
35 !!RETURN VALUE
36
37
38 The __fgetws__ function, if successful, returns
39 ''ws''. If end of stream was already reached or if an
40 error occurred, it returns NULL.
41 !!CONFORMING TO
42
43
44 ISO/ANSI C, UNIX98
45 !!SEE ALSO
46
47
48 fgetwc(3)
49 !!NOTES
50
51
52 The behaviour of __fgetws__ depends on the LC_CTYPE
53 category of the current locale.
54
55
56 In the absence of additional information passed to the fopen
57 call, it is reasonable to expect that __fgetws__ will
58 actually read a multibyte string from the stream and then
59 convert it to a wide character string.
60
61
62 This function is unreliable, because it does not permit to
63 deal properly with null wide characters that may be present
64 in the input.
65 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.