206b64e1d6151005e6781c542368ae8757e25a9d
[ncurses.git] / doc / html / man / curs_getstr.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
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:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
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.                               *
23   *                                                                          *
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       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_getstr.3x,v 1.19 2010/12/04 18:36:44 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
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">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_getstr 3x</H1>
42 <PRE>
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>
44
45
46
47
48 </PRE>
49 <H2><a name="h2-NAME">NAME</a></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
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
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>
67
68
69 </PRE>
70 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></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>.
76
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.
83
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.
88
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).
92
93
94 </PRE>
95 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></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.
99
100        X/Open defines no error conditions.
101
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.
105
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>.
109
110        Functions  with a "mv" prefix first perform a cursor move-
111        ment using <STRONG>wmove</STRONG>, and return an error if the  position  is
112        outside the window, or if the window pointer is null.
113
114
115 </PRE>
116 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
117        Note that <STRONG>getstr</STRONG>, <STRONG>mvgetstr</STRONG>, and <STRONG>mvwgetstr</STRONG> may be macros.
118
119
120 </PRE>
121 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
122        These  functions are described in the XSI Curses standard,
123        Issue 4.  They  read  single-byte  characters  only.   The
124        standard  does  not define any error conditions.  This im-
125        plementation returns ERR if the window pointer is null, or
126        if the lower-level <STRONG>wgetch</STRONG> call returns an ERR.
127
128        SVr3  and early SVr4 curses implementations did not reject
129        function keys; the SVr4.0 documentation claimed that "spe-
130        cial  keys"  (such  as  function keys, "home" key, "clear"
131        key, <EM>etc</EM>.) are "interpreted", without giving details.   It
132        lied.   In  fact,  the  `character'  value appended to the
133        string by those implementations was  predictable  but  not
134        useful  (being,  in  fact, the low-order eight bits of the
135        key's KEY_ value).
136
137        The functions  <STRONG>getnstr</STRONG>,  <STRONG>mvgetnstr</STRONG>,  and  <STRONG>mvwgetnstr</STRONG>  were
138        present but not documented in SVr4.
139
140
141 </PRE>
142 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
143        <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>.
144
145
146
147                                                         <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
148 </PRE>
149 <div class="nav">
150 <ul>
151 <li><a href="#h2-NAME">NAME</a></li>
152 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
153 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
154 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
155 <li><a href="#h2-NOTES">NOTES</a></li>
156 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
157 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
158 </ul>
159 </div>
160 </BODY>
161 </HTML>