2 ****************************************************************************
3 * Copyright 2018,2020 Thomas E. Dickey *
4 * Copyright 1998-2010,2017 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_instr.3x,v 1.20 2020/02/02 23:34:34 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_instr 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_instr 3x</H1>
44 <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>instr</STRONG>, <STRONG>innstr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwinstr</STRONG>, <STRONG>mvwinnstr</STRONG>
51 - get a string of characters from a <STRONG>curses</STRONG> window
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*str);</STRONG>
58 <STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
59 <STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
60 <STRONG>int</STRONG> <STRONG>winnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
61 <STRONG>int</STRONG> <STRONG>mvinstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
62 <STRONG>int</STRONG> <STRONG>mvinnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvwinstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvwinnstr(WINDOW</STRONG> <STRONG>*win,</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 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 These routines return a string of characters in <EM>str</EM>, extracted starting
69 at the current cursor position in the named window. Attributes are
70 stripped from the characters. The four functions with <EM>n</EM> as the last
71 argument return a leading substring at most <EM>n</EM> characters long (exclu-
72 sive of the trailing NUL).
75 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
76 All of the functions return <STRONG>ERR</STRONG> upon failure, or the number of charac-
77 ters actually read into the string.
79 X/Open Curses defines no error conditions. In this implementation:
81 <STRONG>o</STRONG> If the <EM>win</EM> parameter is null, an error is returned,
83 <STRONG>o</STRONG> If the <EM>chstr</EM> parameter is null, an error is returned,
85 Functions with a "mv" prefix first perform a cursor movement using
86 <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
87 the window pointer is null.
90 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
91 Note that all routines except <STRONG>winnstr</STRONG> may be macros.
94 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
95 SVr4 does not document whether a length limit includes or excludes the
98 The ncurses library extends the XSI description by allowing a negative
99 value for <EM>n</EM>. In this case, the functions return the string ending at
103 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
104 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
108 <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
112 <li><a href="#h2-NAME">NAME</a></li>
113 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
114 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
115 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
116 <li><a href="#h2-NOTES">NOTES</a></li>
117 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
118 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>