Debian Codegraph @

doc/html/man/curs_inchstr.3x.html

raw
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_inchstr.3x,v 1.65 2025/10/21 00:05:02 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_inchstr 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_inchstr 3x 2025-10-20 ncurses 6.6 Library calls</H1>
43 <PRE>
44 <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
45
46
47 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
48 <STRONG>inchstr</STRONG>, <STRONG>inchnstr</STRONG>, <STRONG>winchstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchstr</STRONG>, <STRONG>mvinchnstr</STRONG>,
49 <STRONG>mvwinchstr</STRONG>, <STRONG>mvwinchnstr</STRONG> - get a <EM>curses</EM> character string from a window
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
54
55 <STRONG>int</STRONG> <STRONG>inchstr(chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>);</STRONG>
56 <STRONG>int</STRONG> <STRONG>inchnstr(chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
57 <STRONG>int</STRONG> <STRONG>winchstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>winchnstr(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
59
60 <STRONG>int</STRONG> <STRONG>mvinchstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>mvinchnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>mvwinchstr(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>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvwinchnstr(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>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</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>winchstr</STRONG> extracts a <EM>curses</EM> character string from a <EM>curses</EM> window <EM>win</EM>,
68 starting at the cursor and stopping at the end of the line, and stores
69 it in <EM>chstr</EM>, terminating it with a null <EM>curses</EM> character. <STRONG>winchnstr</STRONG>
70 does the same, but copies at most <EM>n</EM> <EM>curses</EM> characters from <EM>win</EM>. A
71 negative <EM>n</EM> implies no limit; <STRONG>winchnstr</STRONG> then works like <STRONG>winchstr</STRONG>.
72 <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants of these functions.
73
74
75 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
76 These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
77
78 In <EM>ncurses</EM>, these functions fail if
79
80 <STRONG>o</STRONG> the <EM>curses</EM> screen has not been initialized,
81
82 <STRONG>o</STRONG> (for functions taking a <EM>WINDOW</EM> pointer argument) <EM>win</EM> is a null
83 pointer, or
84
85 <STRONG>o</STRONG> <EM>chstr</EM> is a null pointer.
86
87 Functions prefixed with "mv" first perform cursor movement and fail if
88 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
89
90
91 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
92 All of these functions except <STRONG>winchnstr</STRONG> may be implemented as macros.
93
94 Reading a line that overflows the array pointed to by <EM>chstr</EM> and its
95 variants causes undefined results. Instead, use the <EM>n</EM>-infixed
96 functions with a positive <EM>n</EM> argument no larger than the size of the
97 buffer backing <EM>chstr</EM>.
98
99
100 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
101 <STRONG>inchnstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchnstr</STRONG>, and <STRONG>mvwinchnstr</STRONG>'s acceptance of
102 negative <EM>n</EM> values is an <EM>ncurses</EM> extension.
103
104
105 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
106 Applications employing <EM>ncurses</EM> extensions should condition their use on
107 the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
108
109 X/Open Curses Issue 4 describes these functions. It specifies no error
110 conditions for them. It characterizes the strings stored by these
111 functions as containing "at most <EM>n</EM> elements" from a window, but does
112 not specify whether the string stored by these functions is null-
113 terminated.
114
115 SVr4 does not document whether it null-terminates the <EM>curses</EM> character
116 string it stores in <EM>chstr</EM>, and does not document whether a trailing
117 null <EM>curses</EM> character counts toward the length limit <EM>n</EM>.
118
119 SVr4 describes a successful return value only as "an integer value
120 other than <EM>ERR</EM>".
121
122
123 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
124 SVr3.1 (1987) introduced these functions.
125
126
127 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
128 <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM>
129 library in its wide-character configuration (<EM>ncursesw</EM>).
130
131 <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_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
132
133 ncurses 6.6 2025-10-20 <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
134 </PRE>
135 <div class="nav">
136 <ul>
137 <li><a href="#h2-NAME">NAME</a></li>
138 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
139 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
140 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
141 <li><a href="#h2-NOTES">NOTES</a></li>
142 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
143 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
144 <li><a href="#h2-HISTORY">HISTORY</a></li>
145 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
146 </ul>
147 </div>
148 </BODY>
149 </HTML>