1curs_getwstr(3CURSES)      Curses Library Functions      curs_getwstr(3CURSES)
2
3
4

NAME

6       curs_getwstr, getwstr, getnwstr, wgetwstr, wgetnwstr, mvgetwstr, mvget‐
7       nwstr, mvwgetwstr, mvwgetnwstr - get  wchar_t  character  strings  from
8       curses terminal keyboard
9

SYNOPSIS

11       cc [ flag ... ] file ... -lcurses [ library .. ]
12       #include <curses.h>
13
14       int getwstr(wchar_t *wstr);
15
16
17       int getnwstr(wchar_t *wstr, int n);
18
19
20       int wgetwstr(WINDOW *win, wchar_t *wstr);
21
22
23       int wgetnwstr(WINDOW *win, wchar_t *wstr, int n);
24
25
26       int mvgetwstr(int y, int x, wchar_t *wstr);
27
28
29       int mvgetnwstr(int y, int x, wchar_t *wstr, int n);
30
31
32       int mvwgetwstr(WINDOW *win, int y, int x, wchar_t *wstr);
33
34
35       int mvwgetnwstr(WINDOW *win, int y, int x, wchar_t *wstr, int n);
36
37

DESCRIPTION

39       The   effect   of   getwstr()  is  as  though  a  series  of  calls  to
40       getwch(3CURSES) were made, until  a  newline  and  carriage  return  is
41       received.  The  resulting value is placed in the area pointed to by the
42       wchar_t pointer  wstr. getnwstr() reads at most n  wchar_t  characters,
43       thus  preventing  a  possible  overflow of the input buffer. The user's
44       erase and kill characters are interpreted, as well as any special  keys
45       (such as function keys, HOME key, CLEAR key, etc.).
46

RETURN VALUE

48       All  routines  return the integer ERR upon failure and an integer value
49       other than ERR upon successful completion.
50

ATTRIBUTES

52       See attributes(5) for a description of the following attributes:
53
54
55
56
57       ┌─────────────────────────────┬─────────────────────────────┐
58       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
59       ├─────────────────────────────┼─────────────────────────────┤
60       │MT-Level                     │Unsafe                       │
61       └─────────────────────────────┴─────────────────────────────┘
62

SEE ALSO

64       curses(3CURSES), getwch(3CURSES), attributes(5)
65

NOTES

67       The header file  <curses.h> automatically  includes  the  header  files
68       <stdio.h>, <unctrl.h>, and <widec.h>.
69
70
71       Note that all routines except  wgetnwstr() may be macros.
72
73
74
75SunOS 5.11                        31 Dec 1996            curs_getwstr(3CURSES)