2 ****************************************************************************
3 * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * @Id: curs_getstr.3x,v 1.19 2010/12/04 18:36:44 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_getstr 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1>curs_getstr 3x</H1>
44 <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>getstr</STRONG>, <STRONG>getnstr</STRONG>, <STRONG>wgetstr</STRONG>, <STRONG>wgetnstr</STRONG>, <STRONG>mvgetstr</STRONG>, <STRONG>mvgetnstr</STRONG>,
52 <STRONG>mvwgetstr</STRONG>, <STRONG>mvwgetnstr</STRONG> - accept character strings from
53 <STRONG>curses</STRONG> terminal keyboard
57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
58 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
60 <STRONG>int</STRONG> <STRONG>getstr(char</STRONG> <STRONG>*str);</STRONG>
61 <STRONG>int</STRONG> <STRONG>getnstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
62 <STRONG>int</STRONG> <STRONG>wgetstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
63 <STRONG>int</STRONG> <STRONG>wgetnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvgetstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
65 <STRONG>int</STRONG> <STRONG>mvwgetstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
66 <STRONG>int</STRONG> <STRONG>mvgetnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
67 <STRONG>int</STRONG> <STRONG>mvwgetnstr(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
71 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
72 The function <STRONG>getstr</STRONG> is equivalent to a series of calls to
73 <STRONG>getch</STRONG>, until a newline or carriage return is received (the
74 terminating character is not included in the returned
75 string). The resulting value is placed in the area point-
76 ed to by the character pointer <EM>str</EM>.
78 <STRONG>wgetnstr</STRONG> reads at most <EM>n</EM> characters, thus preventing a
79 possible overflow of the input buffer. Any attempt to en-
80 ter more characters (other than the terminating newline or
81 carriage return) causes a beep. Function keys also cause
82 a beep and are ignored. The <STRONG>getnstr</STRONG> function reads from
83 the <EM>stdscr</EM> default window.
85 The user's erase and kill characters are interpreted. If
86 keypad mode is on for the window, <STRONG>KEY_LEFT</STRONG> and
87 <STRONG>KEY_BACKSPACE</STRONG> are both considered equivalent to the user's
90 Characters input are echoed only if <STRONG>echo</STRONG> is currently on.
91 In that case, backspace is echoed as deletion of the pre-
92 vious character (typically a left motion).
96 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
97 All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
98 (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>")
99 upon successful completion.
101 X/Open defines no error conditions.
103 In this implementation, these functions return an error if
104 the window pointer is null, or if its timeout expires
105 without having any data.
107 This implementation provides an extension as well. If a
108 SIGWINCH interrupts the function, it will return <STRONG>KEY_RE-</STRONG>
109 <STRONG>SIZE</STRONG> rather than <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>.
111 Functions with a "mv" prefix first perform a cursor move-
112 ment using <STRONG>wmove</STRONG>, and return an error if the position is
113 outside the window, or if the window pointer is null.
117 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
118 Note that <STRONG>getstr</STRONG>, <STRONG>mvgetstr</STRONG>, and <STRONG>mvwgetstr</STRONG> may be macros.
122 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
123 These functions are described in the XSI Curses standard,
124 Issue 4. They read single-byte characters only. The
125 standard does not define any error conditions. This im-
126 plementation returns ERR if the window pointer is null, or
127 if the lower-level <STRONG>wgetch</STRONG> call returns an ERR.
129 SVr3 and early SVr4 curses implementations did not reject
130 function keys; the SVr4.0 documentation claimed that "spe-
131 cial keys" (such as function keys, "home" key, "clear"
132 key, <EM>etc</EM>.) are "interpreted", without giving details. It
133 lied. In fact, the `character' value appended to the
134 string by those implementations was predictable but not
135 useful (being, in fact, the low-order eight bits of the
138 The functions <STRONG>getnstr</STRONG>, <STRONG>mvgetnstr</STRONG>, and <STRONG>mvwgetnstr</STRONG> were
139 present but not documented in SVr4.
143 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
144 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
148 <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
152 <li><a href="#h2-NAME">NAME</a></li>
153 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
154 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
155 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
156 <li><a href="#h2-NOTES">NOTES</a></li>
157 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
158 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>