ncurses 6.0 - patch 20160326
[ncurses.git] / doc / html / man / curs_instr.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2006,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_instr.3x,v 1.16 2010/12/04 18:38:55 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_instr 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_instr 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>                                           <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>instr</STRONG>,  <STRONG>innstr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwin-</STRONG>
50        <STRONG>str</STRONG>, <STRONG>mvwinnstr</STRONG> - get a string of characters from a  <STRONG>curses</STRONG>
51        window
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
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>
65        <STRONG>n);</STRONG>
66
67
68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69        These routines return  a  string  of  characters  in  <EM>str</EM>,
70        extracted  starting  at the current cursor position in the
71        named window.  Attributes are stripped  from  the  charac-
72        ters.   The  four  functions  with  <EM>n</EM> as the last argument
73        return a leading  substring  at  most  <EM>n</EM>  characters  long
74        (exclusive of the trailing NUL).
75
76
77 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
78        All  of the functions return <STRONG>ERR</STRONG> upon failure, or the num-
79        ber of characters actually read into the string.
80
81        X/Open defines no error conditions.  In  this  implementa-
82        tion, if the window parameter is null or the str parameter
83        is null, a zero is returned.
84
85        Functions with a "mv" prefix first perform a cursor  move-
86        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
87        outside the window, or if the window pointer is null.
88
89
90 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
91        Note that all routines except <STRONG>winnstr</STRONG> may be macros.
92
93
94 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
95        SVr4 does not document whether a length limit includes  or
96        excludes the trailing NUL.
97
98        The  ncurses library extends the XSI description by allow-
99        ing a negative value for <EM>n</EM>.  In this case,  the  functions
100        return the string ending at the right margin.
101
102
103 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
104        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
105
106
107
108                                                          <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
109 </PRE>
110 <div class="nav">
111 <ul>
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>
119 </ul>
120 </div>
121 </BODY>
122 </HTML>