curs_getyx(S)

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

Syntax

cc -D_M_TERMCAP ... -lcurses

#include <curses.h>

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

cc -D_M_TERMINFO ... -lcurses

#include <curses.h>

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(S) macro, the cursor position of the window is placed in the two integer variables y and x.

With the getparyx(S) 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(S) and getmaxyx(S) 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).

Notes

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

All of these interfaces are macros and ``&'' is not needed before the variables y and x.

Files

/usr/lib/libcurses.a: the library

Standards conformance

getyx(S), getbegyx(S), getparyx(S), and getmaxyx(S) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.