ncurses 5.3
[ncurses.git] / doc / html / man / curs_getyx.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_getyx.3x,v 1.8 2002/09/21 19:00:38 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_getyx 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_getyx 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>getyx</STRONG>,  <STRONG>getparyx</STRONG>,  <STRONG>getbegyx</STRONG>,  <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor
47        and window coordinates
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
53
54        <STRONG>void</STRONG> <STRONG>getyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
55        <STRONG>void</STRONG> <STRONG>getparyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
56        <STRONG>void</STRONG> <STRONG>getbegyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
57        <STRONG>void</STRONG> <STRONG>getmaxyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
58
59
60 </PRE>
61 <H2>DESCRIPTION</H2><PRE>
62        The <STRONG>getyx</STRONG> macro places the current cursor position of  the
63        given window in the two integer variables <EM>y</EM> and <EM>x</EM>.
64
65        If  <EM>win</EM>  is  a  subwindow,  the  <STRONG>getparyx</STRONG> macro places the
66        beginning coordinates of the  subwindow  relative  to  the
67        parent  window into two integer variables <EM>y</EM> and <EM>x</EM>.  Other-
68        wise, <STRONG>-1</STRONG> is placed into <EM>y</EM> and <EM>x</EM>.
69
70        Like <STRONG>getyx</STRONG>, the <STRONG>getbegyx</STRONG> and  <STRONG>getmaxyx</STRONG>  macros  store  the
71        current  beginning  coordinates  and size of the specified
72        window.
73
74
75 </PRE>
76 <H2>RETURN VALUE</H2><PRE>
77        The return values of these  macros  are  undefined  (<EM>i</EM>.<EM>e</EM>.,
78        they  should not be used as the right-hand side of assign-
79        ment statements).
80
81
82 </PRE>
83 <H2>NOTES</H2><PRE>
84        All of these interfaces are macros.  A "<STRONG>&amp;</STRONG>" is  not  neces-
85        sary before the variables <EM>y</EM> and <EM>x</EM>.
86
87
88 </PRE>
89 <H2>PORTABILITY</H2><PRE>
90        The  <STRONG>getyx</STRONG>,  <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> functions are
91        described in the XSI Curses standard, Issue 4.
92
93        This  implementation  also  provides   <STRONG>getbegx</STRONG>,   <STRONG>getbegy</STRONG>,
94        <STRONG>getcurx</STRONG>,  <STRONG>getcury</STRONG>,  <STRONG>getmaxx</STRONG>,  <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG> and <STRONG>getpary</STRONG>
95        for compatibility with older versions of curses.
96
97
98 </PRE>
99 <H2>SEE ALSO</H2><PRE>
100        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
101
102
103
104
105
106
107
108
109
110
111 </PRE>
112 <HR>
113 <ADDRESS>
114 Man(1) output converted with
115 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
116 </ADDRESS>
117 </BODY>
118 </HTML>