1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
</PRE>
<H2>NAME</H2><PRE>
<B>getstr</B>, <B>getnstr</B>, <B>wgetstr</B>, <B>wgetnstr</B>, <B>mvgetstr</B>, <B>mvgetnstr</B>,
<B>mvwgetstr</B>, <B>mvwgetnstr</B> - accept character strings from
<B>curses</B> terminal keyboard
</PRE>
<H2>SYNOPSIS</H2><PRE>
<B>#include</B> <B><curses.h></B>
<B>int</B> <B>getstr(char</B> <B>*str);</B>
<B>int</B> <B>getnstr(char</B> <B>*str,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>wgetstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str);</B>
<B>int</B> <B>wgetnstr(WINDOW</B> <B>*win,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>mvgetstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B>
<B>int</B> <B>mvwgetstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str);</B>
<B>int</B> <B>mvgetnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
<B>int</B> <B>mvwgetnstr(WINDOW</B> <B>*,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>char</B> <B>*str,</B> <B>int</B> <B>n);</B>
</PRE>
<H2>DESCRIPTION</H2><PRE>
The function <B>getstr</B> is equivalent to a series of calls to
<B>getch</B>, until a newline or carriage return is received (the
terminating character is not included in the returned
string). The resulting value is placed in the area
pointed to by the character pointer <I>str</I>.
<B>wgetnstr</B> reads at most <I>n</I> characters, thus preventing a
possible overflow of the input buffer. Any attempt to
enter more characters (other than the terminating newline
or carriage return) causes a beep. Function keys also
cause a beep and are ignored. The <B>getnstr</B> function reads
from the <I>stdscr</I> default window.
The user's erase and kill characters are interpreted. If
keypad mode is on for the window, <B>KEY_LEFT</B> and
<B>KEY_BACKSPACE</B> are both considered equivalent to the user's
kill character.
Characters input are echoed only if <B>echo</B> is currently on.
In that case, backspace is echoed as deletion of the pre-
vious character (typically a left motion).
</PRE>
<H2>RETURN VALUE</H2><PRE>
All routines return the integer <B>ERR</B> upon failure and an <B>OK</B>
(SVr4 specifies only "an integer value other than <B>ERR</B>")
upon successful completion.
</PRE>
<H2>NOTES</H2><PRE>
Note that <B>getstr</B>, <B>mvgetstr</B>, and <B>mvwgetstr</B> may be macros.
</PRE>
<H2>PORTABILITY</H2><PRE>
These functions are described in the XSI Curses standard,
Issue 4. They read single-byte characters only. The
standard specifies that they return <B>ERR</B> on failure, but
the single error condition <B>EOVERFLOW</B> associated with
extended-level conformance is not yet returned (the XSI
curses support for multi-byte characters is not yet pre-
sent).
SVr3 and early SVr4 curses implementations did not reject
function keys; the SVr4.0 documentation claimed that "spe-
cial keys" (such as function keys, "home" key, "clear"
key, <I>etc</I>.) are interpreted" without giving details. It
lied. In fact, the `character' value appended to the
string by those implementations was predictable but not
useful (being, in fact, the low-order eight bits of the
key's KEY_ value).
The functions <B>getnstr</B>, <B>mvgetnstr</B>, and <B>mvwgetnstr</B> were pre-
sent but not documented in SVr4.
</PRE>
<H2>SEE ALSO</H2><PRE>
<B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_getch.3x.html">curs_getch(3x)</A></B>.
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
|
