| 1 |
<!-- |
| 2 |
**************************************************************************** |
| 3 |
* Copyright 2018-2024,2025 Thomas E. Dickey * |
| 4 |
* Copyright 1998-2010,2017 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_instr.3x,v 1.82 2025/10/21 00:04:35 tom Exp @ |
| 31 |
--> |
| 32 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| 33 |
<HTML> |
| 34 |
<HEAD> |
| 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 2025-10-20 ncurses 6.6 Library calls</TITLE> |
| 38 |
<link rel="author" href="mailto:[email protected]"> |
| 39 |
|
| 40 |
</HEAD> |
| 41 |
<BODY> |
| 42 |
<H1 class="no-header">curs_instr 3x 2025-10-20 ncurses 6.6 Library calls</H1> |
| 43 |
<PRE> |
| 44 |
<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> |
| 45 |
|
| 46 |
|
| 47 |
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> |
| 48 |
<STRONG>instr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvwinstr</STRONG>, <STRONG>innstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwinnstr</STRONG> |
| 49 |
- get a string from a <EM>curses</EM> window |
| 50 |
|
| 51 |
|
| 52 |
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> |
| 53 |
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG> |
| 54 |
|
| 55 |
<STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>);</STRONG> |
| 56 |
<STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>);</STRONG> |
| 57 |
<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> |
| 58 |
<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> |
| 59 |
|
| 60 |
<STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*</STRONG> <EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> |
| 61 |
<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> |
| 62 |
<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> |
| 63 |
<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> |
| 64 |
|
| 65 |
|
| 66 |
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> |
| 67 |
<STRONG>winstr</STRONG> extracts a string from a <EM>curses</EM> window <EM>win</EM>, starting at the |
| 68 |
cursor and stopping at the end of the line, and stores it in <EM>str</EM>, |
| 69 |
terminating it with a null character and omitting any attributes and |
| 70 |
color pair identifier that <EM>curses</EM> associates with each character. |
| 71 |
<STRONG>winnstr</STRONG> does the same, but copies at most <EM>n</EM> characters from <EM>win</EM>. A |
| 72 |
negative <EM>n</EM> implies no limit; <STRONG>winnstr</STRONG> then works like <STRONG>winstr</STRONG>. |
| 73 |
<STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants of these functions. |
| 74 |
|
| 75 |
|
| 76 |
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> |
| 77 |
These functions return the count of characters copied from <EM>win</EM> to <EM>str</EM> |
| 78 |
(not including the null terminator), or <STRONG>ERR</STRONG> upon failure. |
| 79 |
|
| 80 |
In <EM>ncurses</EM>, these functions fail if |
| 81 |
|
| 82 |
<STRONG>o</STRONG> the <EM>curses</EM> screen has not been initialized, |
| 83 |
|
| 84 |
<STRONG>o</STRONG> (for functions taking a <EM>WINDOW</EM> pointer argument) <EM>win</EM> is a null |
| 85 |
pointer, or |
| 86 |
|
| 87 |
<STRONG>o</STRONG> <EM>str</EM> is a null pointer. |
| 88 |
|
| 89 |
Functions prefixed with "mv" first perform cursor movement and fail if |
| 90 |
the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries. |
| 91 |
|
| 92 |
|
| 93 |
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> |
| 94 |
All of these functions except <STRONG>winnstr</STRONG> may be implemented as macros. |
| 95 |
|
| 96 |
Reading a line that overflows the array pointed to by <EM>str</EM> with and its |
| 97 |
variants causes undefined results. Instead, use the <EM>n</EM>-infixed |
| 98 |
functions with a positive <EM>n</EM> argument no larger than the size of the |
| 99 |
buffer backing <EM>str</EM>. |
| 100 |
|
| 101 |
|
| 102 |
</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> |
| 103 |
<STRONG>innstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinnstr</STRONG>, and <STRONG>mvwinnstr</STRONG>'s acceptance of negative <EM>n</EM> |
| 104 |
values is an <EM>ncurses</EM> extension. |
| 105 |
|
| 106 |
|
| 107 |
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> |
| 108 |
Applications employing <EM>ncurses</EM> extensions should condition their use on |
| 109 |
the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro. |
| 110 |
|
| 111 |
X/Open Curses Issue 4 describes these functions. It specifies no error |
| 112 |
conditions for them. |
| 113 |
|
| 114 |
X/Open Curses Issues 4 and 7 both state that <EM>instr</EM>, <EM>winstr</EM>, <EM>mvinstr</EM>, |
| 115 |
and <EM>mvwinstr</EM> return <EM>OK</EM> rather than a character count. This is likely |
| 116 |
an erratum. |
| 117 |
|
| 118 |
<STRONG>o</STRONG> SVr3.1 and SVr4 implemented <EM>winstr</EM> as a wrapper around <EM>winnstr</EM>, |
| 119 |
returning the latter's return value. X/Open Curses's specification |
| 120 |
thus may have been an editorial solecism copied from System V's |
| 121 |
documentation (see below) by X/Open, rather than an intentional |
| 122 |
change. |
| 123 |
|
| 124 |
<STRONG>o</STRONG> <EM>ncurses</EM> retains compatibility with System V <EM>curses</EM> behavior. |
| 125 |
|
| 126 |
SVr4 describes a successful return value only as "an integer value |
| 127 |
other than <EM>ERR</EM>". |
| 128 |
|
| 129 |
SVr4 does not document whether <EM>n</EM> counts the null terminator that these |
| 130 |
functions write to <EM>str</EM>. |
| 131 |
|
| 132 |
|
| 133 |
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE> |
| 134 |
SVr3.1 (1987) introduced these functions. |
| 135 |
|
| 136 |
|
| 137 |
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> |
| 138 |
<STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM> library |
| 139 |
in its wide-character configuration (<EM>ncursesw</EM>). |
| 140 |
|
| 141 |
<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> |
| 142 |
|
| 143 |
ncurses 6.6 2025-10-20 <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> |
| 144 |
</PRE> |
| 145 |
<div class="nav"> |
| 146 |
<ul> |
| 147 |
<li><a href="#h2-NAME">NAME</a></li> |
| 148 |
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> |
| 149 |
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> |
| 150 |
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> |
| 151 |
<li><a href="#h2-NOTES">NOTES</a></li> |
| 152 |
<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li> |
| 153 |
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> |
| 154 |
<li><a href="#h2-HISTORY">HISTORY</a></li> |
| 155 |
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |
| 156 |
</ul> |
| 157 |
</div> |
| 158 |
</BODY> |
| 159 |
</HTML> |