Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

getmaxyx(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.