ncurses 5.6
[mirror-ossqm-ncurses.git] / doc / html / man / curs_getstr.3x.html
blobf5f9d07083a37fd35d58ad6d7909cecc2f18894d
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!--
3 ****************************************************************************
4 * Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. *
5 * *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
28 * authorization. *
29 ****************************************************************************
30 * @Id: curs_getstr.3x,v 1.15 2006/01/12 00:30:58 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_getstr 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_getstr 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG> <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
48 </PRE>
49 <H2>NAME</H2><PRE>
50 <STRONG>getstr</STRONG>, <STRONG>getnstr</STRONG>, <STRONG>wgetstr</STRONG>, <STRONG>wgetnstr</STRONG>, <STRONG>mvgetstr</STRONG>, <STRONG>mvgetnstr</STRONG>,
51 <STRONG>mvwgetstr</STRONG>, <STRONG>mvwgetnstr</STRONG> - accept character strings from
52 <STRONG>curses</STRONG> terminal keyboard
55 </PRE>
56 <H2>SYNOPSIS</H2><PRE>
57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
59 <STRONG>int</STRONG> <STRONG>getstr(char</STRONG> <STRONG>*str);</STRONG>
60 <STRONG>int</STRONG> <STRONG>getnstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
61 <STRONG>int</STRONG> <STRONG>wgetstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
62 <STRONG>int</STRONG> <STRONG>wgetnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvgetstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
64 <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>
65 <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>
66 <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>
69 </PRE>
70 <H2>DESCRIPTION</H2><PRE>
71 The function <STRONG>getstr</STRONG> is equivalent to a series of calls to
72 <STRONG>getch</STRONG>, until a newline or carriage return is received (the
73 terminating character is not included in the returned
74 string). The resulting value is placed in the area point-
75 ed to by the character pointer <EM>str</EM>.
77 <STRONG>wgetnstr</STRONG> reads at most <EM>n</EM> characters, thus preventing a
78 possible overflow of the input buffer. Any attempt to en-
79 ter more characters (other than the terminating newline or
80 carriage return) causes a beep. Function keys also cause
81 a beep and are ignored. The <STRONG>getnstr</STRONG> function reads from
82 the <EM>stdscr</EM> default window.
84 The user's erase and kill characters are interpreted. If
85 keypad mode is on for the window, <STRONG>KEY_LEFT</STRONG> and
86 <STRONG>KEY_BACKSPACE</STRONG> are both considered equivalent to the user's
87 kill character.
89 Characters input are echoed only if <STRONG>echo</STRONG> is currently on.
90 In that case, backspace is echoed as deletion of the pre-
91 vious character (typically a left motion).
94 </PRE>
95 <H2>RETURN VALUE</H2><PRE>
96 All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
97 (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>")
98 upon successful completion.
100 X/Open defines no error conditions.
102 In this implementation, these functions return an error if
103 the window pointer is null, or if its timeout expires
104 without having any data.
106 This implementation provides an extension as well. If a
107 SIGWINCH interrupts the function, it will return <STRONG>KEY_RE-</STRONG>
108 <STRONG>SIZE</STRONG> rather than <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>.
111 </PRE>
112 <H2>NOTES</H2><PRE>
113 Note that <STRONG>getstr</STRONG>, <STRONG>mvgetstr</STRONG>, and <STRONG>mvwgetstr</STRONG> may be macros.
116 </PRE>
117 <H2>PORTABILITY</H2><PRE>
118 These functions are described in the XSI Curses standard,
119 Issue 4. They read single-byte characters only. The
120 standard does not define any error conditions. This im-
121 plementation returns ERR if the window pointer is null, or
122 if the lower-level <STRONG>wgetch</STRONG> call returns an ERR.
124 SVr3 and early SVr4 curses implementations did not reject
125 function keys; the SVr4.0 documentation claimed that "spe-
126 cial keys" (such as function keys, "home" key, "clear"
127 key, <EM>etc</EM>.) are "interpreted", without giving details. It
128 lied. In fact, the `character' value appended to the
129 string by those implementations was predictable but not
130 useful (being, in fact, the low-order eight bits of the
131 key's KEY_ value).
133 The functions <STRONG>getnstr</STRONG>, <STRONG>mvgetnstr</STRONG>, and <STRONG>mvwgetnstr</STRONG> were
134 present but not documented in SVr4.
137 </PRE>
138 <H2>SEE ALSO</H2><PRE>
139 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>.
143 <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
144 </PRE>
145 <HR>
146 <ADDRESS>
147 Man(1) output converted with
148 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
149 </ADDRESS>
150 </BODY>
151 </HTML>