066f81bcb95a29a8873b2e6ad17a8e280b097466
[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-2002,2003 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.12 2003/05/10 20:33:49 jmc 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>
44
45
46
47
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
53
54
55 </PRE>
56 <H2>SYNOPSIS</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>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
75        pointed 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
79        enter  more characters (other than the terminating newline
80        or carriage return) causes a  beep.   Function  keys  also
81        cause  a beep and are ignored.  The <STRONG>getnstr</STRONG> function reads
82        from 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>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.
99
100
101 </PRE>
102 <H2>NOTES</H2><PRE>
103        Note that <STRONG>getstr</STRONG>, <STRONG>mvgetstr</STRONG>, and <STRONG>mvwgetstr</STRONG> may be macros.
104
105
106 </PRE>
107 <H2>PORTABILITY</H2><PRE>
108        These  functions are described in the XSI Curses standard,
109        Issue 4.  They  read  single-byte  characters  only.   The
110        standard  does  not  define  any  error  conditions.  This
111        implementation returns ERR if the window pointer is  null,
112        or if the lower-level <STRONG>wgetch</STRONG> call returns an ERR.
113
114        SVr3  and early SVr4 curses implementations did not reject
115        function keys; the SVr4.0 documentation claimed that "spe-
116        cial  keys"  (such  as  function keys, "home" key, "clear"
117        key, <EM>etc</EM>.) are "interpreted", without giving details.   It
118        lied.   In  fact,  the  `character'  value appended to the
119        string by those implementations was  predictable  but  not
120        useful  (being,  in  fact, the low-order eight bits of the
121        key's KEY_ value).
122
123        The functions <STRONG>getnstr</STRONG>, <STRONG>mvgetnstr</STRONG>, and <STRONG>mvwgetnstr</STRONG> were pre-
124        sent but not documented in SVr4.
125
126
127 </PRE>
128 <H2>SEE ALSO</H2><PRE>
129        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>.
130
131
132
133                                                   <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
134 </PRE>
135 <HR>
136 <ADDRESS>
137 Man(1) output converted with
138 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
139 </ADDRESS>
140 </BODY>
141 </HTML>