ncurses 5.0
[ncurses.git] / Ada95 / html / man / curs_instr.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4        <STRONG>instr</STRONG>,  <STRONG>innstr</STRONG>, <STRONG>winstr</STRONG>, <STRONG>winnstr</STRONG>, <STRONG>mvinstr</STRONG>, <STRONG>mvinnstr</STRONG>, <STRONG>mvwin-</STRONG>
5        <STRONG>str</STRONG>, <STRONG>mvwinnstr</STRONG> - get a string of characters from a  <STRONG>curses</STRONG>
6        window
7
8
9 </PRE>
10 <H2>SYNOPSIS</H2><PRE>
11        <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
12
13        <STRONG>int</STRONG> <STRONG>instr(char</STRONG> <STRONG>*str);</STRONG>
14        <STRONG>int</STRONG> <STRONG>innstr(char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
15        <STRONG>int</STRONG> <STRONG>winstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
16        <STRONG>int</STRONG> <STRONG>winnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
17        <STRONG>int</STRONG> <STRONG>mvinstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
18        <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>
19        <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>
20        <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>
21        <STRONG>n);</STRONG>
22
23
24 </PRE>
25 <H2>DESCRIPTION</H2><PRE>
26        These routines return  a  string  of  characters  in  <EM>str</EM>,
27        extracted  starting  at the current cursor position in the
28        named window.  Attributes are stripped  from  the  charac-
29        ters.   The  four  functions  with  <EM>n</EM> as the last argument
30        return a leading  substring  at  most  <EM>n</EM>  characters  long
31        (exclusive of the trailing NUL).
32
33
34 </PRE>
35 <H2>RETURN VALUE</H2><PRE>
36        All  of the functions return <STRONG>ERR</STRONG> upon failure, or the num-
37        ber of characters actually read into the string.
38
39
40 </PRE>
41 <H2>NOTES</H2><PRE>
42        Note that all routines except <STRONG>winnstr</STRONG> may be macros.
43
44
45 </PRE>
46 <H2>PORTABILITY</H2><PRE>
47        The XSI Curses error  conditions  <STRONG>EILSEQ</STRONG>  and  <STRONG>EILOVERFLOW</STRONG>
48        associated  with  extended-level  conformance  are not yet
49        detected (this implementation does not  yet  support  XPG4
50        multi-byte  characters).  SVr4 does not document whether a
51        length limit includes or excludes the trailing NUL.
52
53        The ncurses library extends the XSI description by  allow-
54        ing  a  negative value for <EM>n</EM>.  In this case, the functions
55        return the string ending at the right margin.
56
57
58 </PRE>
59 <H2>SEE ALSO</H2><PRE>
60        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>.
61
62
63
64
65
66
67
68 </PRE>
69 </BODY>
70 </HTML>