ncurses 5.3
[ncurses.git] / doc / html / man / curs_getstr.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2000,2001 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.11 2002/04/13 22:14:30 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
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>getstr</STRONG>,  <STRONG>getnstr</STRONG>,  <STRONG>wgetstr</STRONG>, <STRONG>wgetnstr</STRONG>, <STRONG>mvgetstr</STRONG>, <STRONG>mvgetnstr</STRONG>,
47        <STRONG>mvwgetstr</STRONG>, <STRONG>mvwgetnstr</STRONG>  -  accept  character  strings  from
48        <STRONG>curses</STRONG> terminal keyboard
49
50
51 </PRE>
52 <H2>SYNOPSIS</H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55        <STRONG>int</STRONG> <STRONG>getstr(char</STRONG> <STRONG>*str);</STRONG>
56        <STRONG>int</STRONG> <STRONG>getnstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
57        <STRONG>int</STRONG> <STRONG>wgetstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
58        <STRONG>int</STRONG> <STRONG>wgetnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
59        <STRONG>int</STRONG> <STRONG>mvgetstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
60        <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>
61        <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>
62        <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>
63
64
65 </PRE>
66 <H2>DESCRIPTION</H2><PRE>
67        The  function <STRONG>getstr</STRONG> is equivalent to a series of calls to
68        <STRONG>getch</STRONG>, until a newline or carriage return is received (the
69        terminating  character  is  not  included  in the returned
70        string).  The  resulting  value  is  placed  in  the  area
71        pointed to by the character pointer <EM>str</EM>.
72
73        <STRONG>wgetnstr</STRONG>  reads  at  most  <EM>n</EM> characters, thus preventing a
74        possible overflow of the input  buffer.   Any  attempt  to
75        enter  more characters (other than the terminating newline
76        or carriage return) causes a  beep.   Function  keys  also
77        cause  a beep and are ignored.  The <STRONG>getnstr</STRONG> function reads
78        from the <EM>stdscr</EM> default window.
79
80        The user's erase and kill characters are interpreted.   If
81        keypad   mode   is   on   for  the  window,  <STRONG>KEY_LEFT</STRONG>  and
82        <STRONG>KEY_BACKSPACE</STRONG> are both considered equivalent to the user's
83        kill character.
84
85        Characters  input are echoed only if <STRONG>echo</STRONG> is currently on.
86        In that case, backspace is echoed as deletion of the  pre-
87        vious character (typically a left motion).
88
89
90 </PRE>
91 <H2>RETURN VALUE</H2><PRE>
92        All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG>
93        (SVr4 specifies only "an integer value  other  than  <STRONG>ERR</STRONG>")
94        upon successful completion.
95
96
97 </PRE>
98 <H2>NOTES</H2><PRE>
99        Note that <STRONG>getstr</STRONG>, <STRONG>mvgetstr</STRONG>, and <STRONG>mvwgetstr</STRONG> may be macros.
100
101
102 </PRE>
103 <H2>PORTABILITY</H2><PRE>
104        These  functions are described in the XSI Curses standard,
105        Issue 4.  They  read  single-byte  characters  only.   The
106        standard  does  not  define  any  error  conditions.  This
107        implementation returns ERR if the window pointer is  null,
108        or if the lower-level <STRONG>wgetch</STRONG> call returns an ERR.
109        SVr3  and early SVr4 curses implementations did not reject
110        function keys; the SVr4.0 documentation claimed that "spe-
111        cial  keys"  (such  as  function keys, "home" key, "clear"
112        key, <EM>etc</EM>.) are interpreted" without  giving  details.   It
113        lied.   In  fact,  the  `character'  value appended to the
114        string by those implementations was  predictable  but  not
115        useful  (being,  in  fact, the low-order eight bits of the
116        key's KEY_ value).
117
118        The functions <STRONG>getnstr</STRONG>, <STRONG>mvgetnstr</STRONG>, and <STRONG>mvwgetnstr</STRONG> were pre-
119        sent but not documented in SVr4.
120
121
122 </PRE>
123 <H2>SEE ALSO</H2><PRE>
124        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>.
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165 </PRE>
166 <HR>
167 <ADDRESS>
168 Man(1) output converted with
169 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
170 </ADDRESS>
171 </BODY>
172 </HTML>