2 ****************************************************************************
3 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * @Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_inchstr 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">
41 <H1 class="no-header">curs_inchstr 3x</H1>
43 <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG> <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>inchstr</STRONG>, <STRONG>inchnstr</STRONG>, <STRONG>winchstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchstr</STRONG>,
50 <STRONG>mvinchnstr</STRONG>, <STRONG>mvwinchstr</STRONG>, <STRONG>mvwinchnstr</STRONG> - get a string of
51 characters (and attributes) 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>inchstr(chtype</STRONG> <STRONG>*chstr);</STRONG>
58 <STRONG>int</STRONG> <STRONG>inchnstr(chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
59 <STRONG>int</STRONG> <STRONG>winchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG>
60 <STRONG>int</STRONG> <STRONG>winchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
61 <STRONG>int</STRONG> <STRONG>mvinchstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG>
62 <STRONG>int</STRONG> <STRONG>mvinchnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvwinchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvwinchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG>
65 <STRONG>int</STRONG> <STRONG>n);</STRONG>
68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 These routines return a NULL-terminated array of <STRONG>chtype</STRONG>
70 quantities, starting at the current cursor position in the
71 named window and ending at the right margin of the window.
72 The four functions with <EM>n</EM> as the last argument, return a
73 leading substring at most <EM>n</EM> characters long (exclusive of
74 the trailing (chtype)0). Constants defined in <STRONG><curses.h></STRONG>
75 can be used with the <STRONG>&</STRONG> (logical AND) operator to extract
76 the character or the attribute alone from any position in
77 the <EM>chstr</EM> [see <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>].
80 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
81 All routines return the integer <STRONG>ERR</STRONG> upon failure and an
82 integer value other than <STRONG>ERR</STRONG> upon successful completion
83 (the number of characters retrieved, exclusive of the
86 No error conditions are defined. If the <EM>chstr</EM> parameter
87 is null, no data is returned, and the return value is ze-
90 Functions with a "mv" prefix first perform a cursor move-
91 ment using <STRONG>wmove</STRONG>, and return an error if the position is
92 outside the window, or if the window pointer is null.
95 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
96 Note that all routines except <STRONG>winchnstr</STRONG> may be macros.
97 SVr4 does not document whether the result string is zero-
98 terminated; it does not document whether a length limit
99 argument includes any trailing 0; and it does not document
100 the meaning of the return value.
103 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
104 These functions are described in the XSI Curses standard,
105 Issue 4. It is no more specific than the SVr4 documenta-
106 tion on the trailing 0. It does specify that the success-
107 ful return of the functions is <STRONG>OK</STRONG>.
110 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
111 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
113 Comparable functions in the wide-character (ncursesw) li-
114 brary are described in <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>.
118 <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
122 <li><a href="#h2-NAME">NAME</a></li>
123 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
124 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
125 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
126 <li><a href="#h2-NOTES">NOTES</a></li>
127 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
128 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>