ncurses 4.2
[ncurses.git] / Ada95 / html / curs_getyx.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>getyx</STRONG>,  <STRONG>getparyx</STRONG>,  <STRONG>getbegyx</STRONG>,  <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor
5        and window coordinates
6
7
8 </PRE>
9 <H2>SYNOPSIS</H2><PRE>
10        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
11
12        <STRONG>void</STRONG> <STRONG>getyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
13        <STRONG>void</STRONG> <STRONG>getparyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
14        <STRONG>void</STRONG> <STRONG>getbegyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
15        <STRONG>void</STRONG> <STRONG>getmaxyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
16
17
18 </PRE>
19 <H2>DESCRIPTION</H2><PRE>
20        The <STRONG>getyx</STRONG> macro places the current cursor position of  the
21        given window in the two integer variables <EM>y</EM> and <EM>x</EM>.
22
23        If  <EM>win</EM>  is  a  subwindow,  the  <STRONG>getparyx</STRONG> macro places the
24        beginning coordinates of the  subwindow  relative  to  the
25        parent  window into two integer variables <EM>y</EM> and <EM>x</EM>.  Other-
26        wise, <STRONG>-1</STRONG> is placed into <EM>y</EM> and <EM>x</EM>.
27
28        Like <STRONG>getyx</STRONG>, the <STRONG>getbegyx</STRONG> and  <STRONG>getmaxyx</STRONG>  macros  store  the
29        current  beginning  coordinates  and size of the specified
30        window.
31
32
33 </PRE>
34 <H2>RETURN VALUE</H2><PRE>
35        The return values of these  macros  are  undefined  (<EM>i</EM>.<EM>e</EM>.,
36        they  should not be used as the right-hand side of assign-
37        ment statements).
38
39
40 </PRE>
41 <H2>NOTES</H2><PRE>
42        All of these interfaces are macros and  that  "<STRONG>&amp;</STRONG>"  is  not
43        necessary before the variables <EM>y</EM> and <EM>x</EM>.
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        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>
55
56
57
58
59
60
61
62
63
64
65
66
67
68 </PRE>
69 </BODY>
70 </HTML>