1 <!DOCTYPE HTML PUBLIC
"-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp @
34 <TITLE>curs_inchstr
3x
</TITLE>
35 <link rev=made
href=
"mailto:bug-ncurses@gnu.org">
36 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1">
39 <H1>curs_inchstr
3x
</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>
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
56 <H2>SYNOPSIS
</H2><PRE>
57 <STRONG>#include
</STRONG> <STRONG><curses.h
></STRONG>
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>
71 <H2>DESCRIPTION
</H2><PRE>
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><curses.h
></STRONG>
78 can be used with the
<STRONG>&</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>].
84 <H2>RETURN VALUE
</H2><PRE>
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
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-
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.
101 Note that all routines except
<STRONG>winchnstr
</STRONG> may be macros.
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.
109 <H2>PORTABILITY
</H2><PRE>
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>.
117 <H2>SEE ALSO
</H2><PRE>
118 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>,
<STRONG><A HREF=
"curs_inch.3x.html">curs_inch(
3x)
</A></STRONG>.
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>.
125 <STRONG><A HREF=
"curs_inchstr.3x.html">curs_inchstr(
3x)
</A></STRONG>
129 Man(
1) output converted with
130 <a href=
"http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html
</a>