getyx getparyx getbegyx getmaxyx

The getyx set of routines is used to get positional information for a window.

Syntax

   #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);

Parameters

win: A pointer to the window from which to get positional information.
x: The integer in which to place x coordinate position of cursor.
y: The integer in which to place y coordinate position of cursor.

Return Values

None

Description

The getyx() routine returns the x and y coordinates of the cursor in win. The getparyx() routine returns the beginning coordinates of win relative to its parent window. If win is not a subwindow, getparyx() sets x and y to -1. The getbegyx() routine returns the beginning coordinates of win relative to the screen. The getmaxyx() routine returns the size of window win.




	NOTE: These routines are all macros. An ampersand (&) before the `y` and `x` variables is not necessary.

Implementation Considerations

The getyx() routine is identical to XPG/3. The getparyx(), getbegyx(), and getmaxyx() routines are UNIX System V implementations.

Portability

The getyx() routine conforms to HP-UX, UNIX System V, and XPG/3. The getparyx(), getbegyx(), and getmaxyx() routines conform to UNIX System V.