CURS_GETYX(3CURSES) Curses Library Functions CURS_GETYX(3CURSES)


NAME


curs_getyx, getyx, getparyx, getbegyx, getmaxyx - get curses cursor and
window coordinates

SYNOPSIS


cc [ flag ... ] file ... -lcurses [ library ... ]
#include <curses.h>

void getyx(WINDOW *win, int y, int x);


void getparyx(WINDOW *win, int y, int x);


void getbegyx(WINDOW *win, int y, int x);


void getmaxyx(WINDOW *win, int y, int x);


DESCRIPTION


With the getyx() macro, the cursor position of the window is placed in
the two integer variables y and x.


With the getparyx() macro, if win is a subwindow, the beginning
coordinates of the subwindow relative to the parent window are placed
into two integer variables, y and x. Otherwise, -1 is placed into y and
x.


Like getyx() , the getbegyx() and getmaxyx() macros store the current
beginning coordinates and size of the specified window.

RETURN VALUES


The return values of these macros are undefined (that is, they should not
be used as the right-hand side of assignment statements).

ATTRIBUTES


See attributes(7) for descriptions of the following attributes:


+---------------+-----------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------+
|MT-Level | Unsafe |
+---------------+-----------------+

SEE ALSO


curses(3CURSES), attributes(7)

NOTES


The header <curses.h> automatically includes the headers <stdio.h> and
<unctrl.h>.


Note that all of these interfaces are macros and that ``&'' is not
necessary before the variables y and x.


December 31, 1996 CURS_GETYX(3CURSES)