1getws(3C)                Standard C Library Functions                getws(3C)
2
3
4

NAME

6       getws, fgetws - get a wide-character string from a stream
7

SYNOPSIS

9       #include <stdio.h>
10       include <widec.h>
11
12       wchar_t *getws(wchar_t *ws);
13
14
15       #include <stdio.h>
16       include <wchar.h>
17
18       wchar_t *fgetws(wchar_t *restrict ws, int n, FILE *restrict stream);
19
20

DESCRIPTION

22       The  getws()  function  reads  a string of characters from the standard
23       input stream, stdin, converts these  characters  to  the  corresponding
24       wide-character  codes,  and  writes them to the array pointed to by ws,
25       until a newline character is read, converted and transferred to  ws  or
26       an end-of-file condition is encountered. The wide-character string, ws,
27       is then terminated with a null wide-character code.
28
29
30       The fgetws() function reads characters from the stream,  converts  them
31       to  the  corresponding  wide-character  codes,   and places them in the
32       wchar_t array pointed to by ws until n−1 characters are read, or  until
33       a  newline  character  is  read, converted and transferred to ws, or an
34       end-of-file condition is encountered. The wide-character string, ws, is
35       then terminated with a null wide-character code.
36
37
38       If  an error occurs, the resulting value of the file position indicator
39       for the stream is indeterminate.
40
41
42       The fgetws() function may mark the st_atime field of the  file  associ‐
43       ated  with  stream  for  update.  The st_atime field will be marked for
44       update by the  first  successful  execution  of  fgetc(3C),  fgets(3C),
45       fgetwc(3C),  fgetws(),  fread(3C),  fscanf(3C),  getc(3C), getchar(3C),
46       gets(3C), or scanf(3C) using stream that returns data not supplied by a
47       prior call to ungetc(3C) or ungetwc(3C).
48

RETURN VALUES

50       Upon  successful  completion,  getws()  and  fgetws() return ws. If the
51       stream is at end-of-file, the end-of-file indicator for the  stream  is
52       set  and  fgetws() returns a null pointer. For standard-conforming (see
53       standards(5)) applications, if the end-of-file indicator for the stream
54       is set, fgetws() returns a null pointer whether or not the stream is at
55       end-of-file. If a read error occurs, the error indicator for the stream
56       is  set  and fgetws() returns a null pointer and sets errno to indicate
57       the error.
58

ERRORS

60       See fgetwc(3C) for the conditions that will cause fgetws() to fail.
61

ATTRIBUTES

63       See attributes(5) for descriptions of the following attributes:
64
65
66
67
68       ┌─────────────────────────────┬─────────────────────────────┐
69       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
70       ├─────────────────────────────┼─────────────────────────────┤
71       │Interface Stability          │fgetws() is Standard.        │
72       ├─────────────────────────────┼─────────────────────────────┤
73       │MT-Level                     │MT-Safe                      │
74       └─────────────────────────────┴─────────────────────────────┘
75

SEE ALSO

77       ferror(3C), fgetwc(3C),  fread(3C),  getwc(3C),  putws(3C),  scanf(3C),
78       ungetc(3C), ungetwc(3C)attributes(5), standards(5)
79
80
81
82SunOS 5.11                        15 Oct 2003                        getws(3C)