ncurses 5.1
[ncurses.git] / doc / html / man / curs_inch.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>inch</B>,  <B>winch</B>,  <B>mvinch</B>,  <B>mvwinch</B>  -  get  a  character  and
9        attributes from a <B>curses</B> window
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14        <B>#include</B> <B>&lt;curses.h&gt;</B>
15
16        <B>chtype</B> <B>inch(void);</B>
17        <B>chtype</B> <B>winch(WINDOW</B> <B>*win);</B>
18        <B>chtype</B> <B>mvinch(int</B> <B>y,</B> <B>int</B> <B>x);</B>
19        <B>chtype</B> <B>mvwinch(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B>
20
21
22 </PRE>
23 <H2>DESCRIPTION</H2><PRE>
24        These routines return the character, of  type  <B>chtype</B>,  at
25        the   current  position  in  the  named  window.   If  any
26        attributes are set for that  position,  their  values  are
27        OR'ed  into  the  value  returned.   Constants  defined in
28        <B>&lt;curses.h&gt;</B> can be used with the <B>&amp;</B> (logical  AND)  operator
29        to extract the character or attributes alone.
30
31
32    <B>Attributes</B>
33        The  following  bit-masks  may  be  AND-ed with characters
34        returned by <B>winch</B>.
35
36        <B>A_CHARTEXT</B>     Bit-mask to extract character
37        <B>A_ATTRIBUTES</B>   Bit-mask to extract attributes
38        <B>A_COLOR</B>        Bit-mask to extract color-pair field information
39
40
41 </PRE>
42 <H2>NOTES</H2><PRE>
43        Note that all of these routines may be macros.
44
45
46 </PRE>
47 <H2>PORTABILITY</H2><PRE>
48        These functions are described in the XSI Curses  standard,
49        Issue 4.
50
51
52 </PRE>
53 <H2>SEE ALSO</H2><PRE>
54        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>.
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71 </PRE>
72 <HR>
73 <ADDRESS>
74 Man(1) output converted with
75 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
76 </ADDRESS>
77 </BODY>
78 </HTML>