ncurses 5.1
[ncurses.git] / doc / html / man / curs_getyx.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>getyx</B>,  <B>getparyx</B>,  <B>getbegyx</B>,  <B>getmaxyx</B> - get <B>curses</B> cursor
9        and window coordinates
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14        <B>#include</B> <B>&lt;curses.h&gt;</B>
15
16        <B>void</B> <B>getyx(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B>
17        <B>void</B> <B>getparyx(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B>
18        <B>void</B> <B>getbegyx(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B>
19        <B>void</B> <B>getmaxyx(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        The <B>getyx</B> macro places the current cursor position of  the
25        given window in the two integer variables <I>y</I> and <I>x</I>.
26
27        If  <I>win</I>  is  a  subwindow,  the  <B>getparyx</B> macro places the
28        beginning coordinates of the  subwindow  relative  to  the
29        parent  window into two integer variables <I>y</I> and <I>x</I>.  Other-
30        wise, <B>-1</B> is placed into <I>y</I> and <I>x</I>.
31
32        Like <B>getyx</B>, the <B>getbegyx</B> and  <B>getmaxyx</B>  macros  store  the
33        current  beginning  coordinates  and size of the specified
34        window.
35
36
37 </PRE>
38 <H2>RETURN VALUE</H2><PRE>
39        The return values of these  macros  are  undefined  (<I>i</I>.<I>e</I>.,
40        they  should not be used as the right-hand side of assign-
41        ment statements).
42
43
44 </PRE>
45 <H2>NOTES</H2><PRE>
46        All of these interfaces are macros and  that  "<B>&amp;</B>"  is  not
47        necessary before the variables <I>y</I> and <I>x</I>.
48
49
50 </PRE>
51 <H2>PORTABILITY</H2><PRE>
52        These  functions are described in the XSI Curses standard,
53        Issue 4.
54
55
56 </PRE>
57 <H2>SEE ALSO</H2><PRE>
58        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>
59
60
61
62
63
64
65
66
67
68
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>