Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / curs_inchstr.3x.html
blob: b231595073290765799be8fe3a23dfa0da399596 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]3 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]29 * @Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]41<H1 class="no-header">curs_inchstr 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50 <STRONG>inchstr</STRONG>, <STRONG>inchnstr</STRONG>, <STRONG>winchstr</STRONG>, <STRONG>winchnstr</STRONG>, <STRONG>mvinchstr</STRONG>,
51 <STRONG>mvinchnstr</STRONG>, <STRONG>mvwinchstr</STRONG>, <STRONG>mvwinchnstr</STRONG> - get a string of
52 characters (and attributes) from a <STRONG>curses</STRONG> window
53
54
55</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]56<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59 <STRONG>int</STRONG> <STRONG>inchstr(chtype</STRONG> <STRONG>*chstr);</STRONG>
60 <STRONG>int</STRONG> <STRONG>inchnstr(chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
61 <STRONG>int</STRONG> <STRONG>winchstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG>
62 <STRONG>int</STRONG> <STRONG>winchnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvinchstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>*chstr);</STRONG>
64 <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>
65 <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>
66 <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>
67 <STRONG>int</STRONG> <STRONG>n);</STRONG>
68
69
70</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]71<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]72 These routines return a NULL-terminated array of <STRONG>chtype</STRONG>
73 quantities, starting at the current cursor position in the
74 named window and ending at the right margin of the window.
75 The four functions with <EM>n</EM> as the last argument, return a
76 leading substring at most <EM>n</EM> characters long (exclusive of
77 the trailing (chtype)0). Constants defined in <STRONG>&lt;curses.h&gt;</STRONG>
78 can be used with the <STRONG>&amp;</STRONG> (logical AND) operator to extract
79 the character or the attribute alone from any position in
80 the <EM>chstr</EM> [see <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>].
81
82
83</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]84<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]85 All routines return the integer <STRONG>ERR</STRONG> upon failure and an
86 integer value other than <STRONG>ERR</STRONG> upon successful completion
87 (the number of characters retrieved, exclusive of the
88 trailing 0).
89
90 No error conditions are defined. If the <EM>chstr</EM> parameter
91 is null, no data is returned, and the return value is ze-
92 ro.
93
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]94 Functions with a "mv" prefix first perform a cursor move-
95 ment using <STRONG>wmove</STRONG>, and return an error if the position is
96 outside the window, or if the window pointer is null.
97
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]98
99</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]100<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]101 Note that all routines except <STRONG>winchnstr</STRONG> may be macros.
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]102 SVr4 does not document whether the result string is zero-
103 terminated; it does not document whether a length limit
104 argument includes any trailing 0; and it does not document
105 the meaning of the return value.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]106
107
108</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]109<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]110 These functions are described in the XSI Curses standard,
111 Issue 4. It is no more specific than the SVr4 documenta-
112 tion on the trailing 0. It does specify that the success-
113 ful return of the functions is <STRONG>OK</STRONG>.
114
115
116</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]117<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]118 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
119
120 Comparable functions in the wide-character (ncursesw) li-
121 brary are described in <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>.
122
123
124
125 <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
126</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]127<div class="nav">
128<ul>
129<li><a href="#h2-NAME">NAME</a></li>
130<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
131<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
132<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
133<li><a href="#h2-NOTES">NOTES</a></li>
134<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
135<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
136</ul>
137</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]138</BODY>
139</HTML>