ncurses 5.1
[ncurses.git] / doc / html / man / curs_inchstr.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>inchstr</B>,   <B>inchnstr</B>,   <B>winchstr</B>,   <B>winchnstr</B>,   <B>mvinchstr</B>,
9        <B>mvinchnstr</B>, <B>mvwinchstr</B>, <B>mvwinchnstr</B>  -  get  a  string  of
10        characters (and attributes) from a <B>curses</B> window
11
12
13 </PRE>
14 <H2>SYNOPSIS</H2><PRE>
15        <B>#include</B> <B>&lt;curses.h&gt;</B>
16
17        <B>int</B> <B>inchstr(chtype</B> <B>*chstr);</B>
18        <B>int</B> <B>inchnstr(chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
19        <B>int</B> <B>winchstr(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>*chstr);</B>
20        <B>int</B> <B>winchnstr(WINDOW</B> <B>*win,</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
21        <B>int</B> <B>mvinchstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr);</B>
22        <B>int</B> <B>mvinchnstr(int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr,</B> <B>int</B> <B>n);</B>
23        <B>int</B> <B>mvwinchstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr);</B>
24        <B>int</B>  <B>mvwinchnstr(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x,</B> <B>chtype</B> <B>*chstr,</B>
25        <B>int</B> <B>n);</B>
26
27
28 </PRE>
29 <H2>DESCRIPTION</H2><PRE>
30        These routines return a NULL-terminated  array  of  <B>chtype</B>
31        quantities, starting at the current cursor position in the
32        named window and ending at the right margin of the window.
33        The  four  functions with <I>n</I> as the last argument, return a
34        leading substring at most <I>n</I> characters long (exclusive  of
35        the  trailing (chtype)0).  Constants defined in <B>&lt;curses.h&gt;</B>
36        can be used with the <B>&amp;</B> (logical AND) operator  to  extract
37        the  character or the attribute alone from any position in
38        the <I>chstr</I> [see <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>].
39
40
41 </PRE>
42 <H2>RETURN VALUE</H2><PRE>
43        All routines return the integer <B>ERR</B> upon  failure  and  an
44        integer  value  other  than <B>ERR</B> upon successful completion
45        (the number of  characters  retrieved,  exclusive  of  the
46        trailing 0).
47
48
49 </PRE>
50 <H2>NOTES</H2><PRE>
51        Note  that  all  routines  except <B>winchnstr</B> may be macros.
52        SVr4 does not document whether the result string is 0-ter-
53        minated; it does not document whether a length limit argu-
54        ment includes any trailing 0; and it does not document the
55        meaning of the return value.
56
57
58 </PRE>
59 <H2>PORTABILITY</H2><PRE>
60        These  functions are described in the XSI Curses standard,
61        Issue 4.  It is no more specific than the SVr4  documenta-
62        tion on the trailing 0.  It does specify that the success-
63        ful return of the functions is <B>OK</B>.
64
65
66 </PRE>
67 <H2>SEE ALSO</H2><PRE>
68        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_inch.3x.html">curs_inch(3x)</A></B>.
69
70
71
72
73 </PRE>
74 <HR>
75 <ADDRESS>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
78 </ADDRESS>
79 </BODY>
80 </HTML>