Manual pages › X Window and screen libraries (3X)

curs_getyx(3X)

get curses cursor and window coordinates

From the original Amiga UNIX 2.1 manual. Some things it mentions may not be in this release.

NAME

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

SYNOPSIS

#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 VALUE

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

NOTES

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