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_instr.3x,v 1.16 2010/12/04 18:38:55 tom Exp @
34 <TITLE>curs_instr
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_instr
3x
</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF=
"curs_instr.3x.html">curs_instr(
3x)
</A></STRONG> <STRONG><A HREF=
"curs_instr.3x.html">curs_instr(
3x)
</A></STRONG>
50 <STRONG>instr
</STRONG>,
<STRONG>innstr
</STRONG>,
<STRONG>winstr
</STRONG>,
<STRONG>winnstr
</STRONG>,
<STRONG>mvinstr
</STRONG>,
<STRONG>mvinnstr
</STRONG>,
<STRONG>mvwin-
</STRONG>
51 <STRONG>str
</STRONG>,
<STRONG>mvwinnstr
</STRONG> - get a string of characters from a
<STRONG>curses
</STRONG>
56 <H2>SYNOPSIS
</H2><PRE>
57 <STRONG>#include
</STRONG> <STRONG><curses.h
></STRONG>
59 <STRONG>int
</STRONG> <STRONG>instr(char
</STRONG> <STRONG>*str);
</STRONG>
60 <STRONG>int
</STRONG> <STRONG>innstr(char
</STRONG> <STRONG>*str,
</STRONG> <STRONG>int
</STRONG> <STRONG>n);
</STRONG>
61 <STRONG>int
</STRONG> <STRONG>winstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>char
</STRONG> <STRONG>*str);
</STRONG>
62 <STRONG>int
</STRONG> <STRONG>winnstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>char
</STRONG> <STRONG>*str,
</STRONG> <STRONG>int
</STRONG> <STRONG>n);
</STRONG>
63 <STRONG>int
</STRONG> <STRONG>mvinstr(int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>char
</STRONG> <STRONG>*str);
</STRONG>
64 <STRONG>int
</STRONG> <STRONG>mvinnstr(int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>char
</STRONG> <STRONG>*str,
</STRONG> <STRONG>int
</STRONG> <STRONG>n);
</STRONG>
65 <STRONG>int
</STRONG> <STRONG>mvwinstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>char
</STRONG> <STRONG>*str);
</STRONG>
66 <STRONG>int
</STRONG> <STRONG>mvwinnstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>char
</STRONG> <STRONG>*str,
</STRONG> <STRONG>int
</STRONG>
71 <H2>DESCRIPTION
</H2><PRE>
72 These routines return a string of characters in
<EM>str
</EM>,
73 extracted starting at the current cursor position in the
74 named window. Attributes are stripped from the charac-
75 ters. The four functions with
<EM>n
</EM> as the last argument
76 return a leading substring at most
<EM>n
</EM> characters long
77 (exclusive of the trailing NUL).
81 <H2>RETURN VALUE
</H2><PRE>
82 All of the functions return
<STRONG>ERR
</STRONG> upon failure, or the num-
83 ber of characters actually read into the string.
85 X/Open defines no error conditions. In this implementa-
86 tion, if the window parameter is null or the str parameter
87 is null, a zero is returned.
89 Functions with a
"mv" prefix first perform a cursor move-
90 ment using
<STRONG>wmove
</STRONG>, and return an error if the position is
91 outside the window, or if the window pointer is null.
96 Note that all routines except
<STRONG>winnstr
</STRONG> may be macros.
100 <H2>PORTABILITY
</H2><PRE>
101 SVr4 does not document whether a length limit includes or
102 excludes the trailing NUL.
104 The ncurses library extends the XSI description by allow-
105 ing a negative value for
<EM>n
</EM>. In this case, the functions
106 return the string ending at the right margin.
110 <H2>SEE ALSO
</H2><PRE>
111 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>.
115 <STRONG><A HREF=
"curs_instr.3x.html">curs_instr(
3x)
</A></STRONG>
119 Man(
1) output converted with
120 <a href=
"http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html
</a>