get_wstr(3xcurses)

1getn_wstr(3XCURSES)     X/Open Curses Library Functions    getn_wstr(3XCURSES)
2
3
4

NAME

6       getn_wstr,    get_wstr,    mvgetn_wstr,    mvget_wstr,    mvwgetn_wstr,
7       mvwget_wstr, wgetn_wstr, wget_wstr - get a wide character  string  from
8       terminal
9

SYNOPSIS

11       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
12        -R  /usr/xpg4/lib  -lcurses  [ library... ]
13
14       c89 [ flag... ] file... -lcurses [ library... ]
15
16       #include <curses.h>
17
18       int getn_wstr(wint_t *wstr, int n);
19
20
21       int get_wstr(wint_t *wstr);
22
23
24       int mvgetn_wstr(int y, int x, wint_t *wstr, int n);
25
26
27       int mvget_wstr(int y, int x, wint_t *wstr);
28
29
30       int mvwgetn_wstr(WINDOW *win, int y, int x, wint_t *wstr, int n);
31
32
33       int mvwget_wstr(WINDOW *win, int y, int x, wint_t *wstr);
34
35
36       int wgetn_wstr(WINDOW *win, wint_t *wstr, int n);
37
38
39       int wget_wstr(WINDOW *win, wint_t *wstr);
40
41

DESCRIPTION

43       The  get_wstr()  and  wget_wstr() functions get a wide character string
44       from the terminal associated with the window  stdscr  or  window   win,
45       respectively. The mvget_str() and mvwget_wstr() functions move the cur‐
46       sor to  the position specified in stdscr or win, respectively, then get
47       a  wide character string.
48
49
50       These functions call wget_wch(3XCURSES) and place each received charac‐
51       ter  in wstr until a newline character, end-of-line character, or  end-
52       of-file  character is received, which is also placed in wstr. The erase
53       and kill characters set by the user are processed.
54
55
56       The getn_wstr(), mvgetn_wstr(), mvwgetn_wstr() and  wgetn_wstr()  func‐
57       tions  read  at most n characters.  These functions are used to prevent
58       overflowing the input buffer.
59

PARAMETERS

61       wstr    Is a pointer to the area where the character string  is  to  be
62               placed.
63
64
65       n       Is the maximum number of characters to read from input.
66
67
68       y       Is  the  y  (row)  coordinate of starting position of character
69               string to be read.
70
71
72       x       Is the x (column) coordinate of starting position of  character
73               string to be read.
74
75
76       win     points  to  the  window associated with the terminal from which
77               the character  is to be read.
78
79

RETURN VALUES

81       On success, these functions return OK. Otherwise, they return ERR.
82

ERRORS

84       None.
85

ATTRIBUTES

87       See attributes(5) for descriptions of the following attributes:
88
89
90
91
92       ┌─────────────────────────────┬─────────────────────────────┐
93       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
94       ├─────────────────────────────┼─────────────────────────────┤
95       │Interface Stability          │Standard                     │
96       ├─────────────────────────────┼─────────────────────────────┤
97       │MT-Level                     │Unsafe                       │
98       └─────────────────────────────┴─────────────────────────────┘
99