blob: 50d0f20e2d9b928c19a09576bc950c17d2bfe4f2 [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -04001<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05302 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -04003 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2010,2017 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05305 * *
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 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -040030 * @Id: curs_instr.3x,v 1.51 2024/04/20 21:24:19 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053031-->
Steve Kondikae271bc2015-11-15 02:50:53 +010032<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053033<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +010035<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
micky3879b9f5e72025-07-08 18:04:53 -040036<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>curs_instr 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053040</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -040042<H1 class="no-header">curs_instr 3x 2024-04-20 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053043<PRE>
micky3879b9f5e72025-07-08 18:04:53 -040044<STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053045
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -040049</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 from a <EM>curses</EM> window
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053052
53
micky3879b9f5e72025-07-08 18:04:53 -040054</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053055 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
micky3879b9f5e72025-07-08 18:04:53 -040057 <STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>winnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
61
62 <STRONG>int</STRONG> <STRONG>mvinstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvinnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvwinstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>mvwinnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053066
67
micky3879b9f5e72025-07-08 18:04:53 -040068</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 These routines return a string of characters in <EM>str</EM>, starting at the
70 current cursor position in the named window. Attributes are stripped
71 from the characters.
72
73 The four functions with <EM>n</EM> as the last argument return a leading
74 substring at most <EM>n</EM> characters long (exclusive of the trailing NUL).
75 Transfer stops at the end of the current line, or when <EM>n</EM> characters
76 have been stored at the location referenced by <EM>str</EM>.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053077
78
micky3879b9f5e72025-07-08 18:04:53 -040079</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
80 All of the functions return <STRONG>ERR</STRONG> upon failure, or the number of
81 characters actually read into the string.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053082
micky3879b9f5e72025-07-08 18:04:53 -040083 X/Open Curses defines no error conditions. This implementation returns
84 an error
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053085
micky3879b9f5e72025-07-08 18:04:53 -040086 <STRONG>o</STRONG> if the <EM>win</EM> parameter is null or
87
88 <STRONG>o</STRONG> if the <EM>chstr</EM> parameter is null.
89
90 Functions prefixed with "mv" first perform cursor movement and fail if
91 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
Steve Kondikae271bc2015-11-15 02:50:53 +010092
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053093
micky3879b9f5e72025-07-08 18:04:53 -040094</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
95 All routines except <STRONG>winnstr</STRONG> may be macros.
96
97 Reading a line that overflows the array pointed to by <EM>str</EM> with <STRONG>instr</STRONG>,
98 <STRONG>mvinstr</STRONG>, <STRONG>mvwinstr</STRONG> or <STRONG>winstr</STRONG> causes undefined results. Therefore, the
99 use of <STRONG>innstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwinnstr</STRONG>, or <STRONG>winnstr</STRONG> is recommended.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530100
101
micky3879b9f5e72025-07-08 18:04:53 -0400102</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
103 SVr4 does not document whether a length limit includes or excludes the
104 trailing NUL.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530105
micky3879b9f5e72025-07-08 18:04:53 -0400106 The <EM>ncurses</EM> library extends the X/Open Curses description by allowing a
107 negative value for <EM>n</EM>. In this case, the functions return the string
108 ending at the right margin.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530109
110
micky3879b9f5e72025-07-08 18:04:53 -0400111</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
112 <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM> library
113 in its wide-character configuration (<EM>ncursesw</EM>).
114
115 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>, <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530116
117
118
micky3879b9f5e72025-07-08 18:04:53 -0400119ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530120</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100121<div class="nav">
122<ul>
123<li><a href="#h2-NAME">NAME</a></li>
124<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
125<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
126<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
127<li><a href="#h2-NOTES">NOTES</a></li>
128<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
129<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
130</ul>
131</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530132</BODY>
133</HTML>