Go to main content

man pages section 3: Curses Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

getyx(3XCURSES)

Name

getbegyx, getmaxyx, getparyx, getyx - get cursor or window coordinates

Synopsis

cc [ flag... ] file... –I /usr/xpg4/include –L /usr/xpg4/lib \
–R /usr/xpg4/lib –lcurses [ library... ]

c89 [ flag... ] file... –lcurses [ library... ]
 
#include <curses.h>

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

Description

The getyx() macro stores the current cursor position of the specified window in x and y.

The getparyx() macro stores the x and y coordinates (relative to the parent window) of the specified window's origin (upper-left corner). If win does not point to a subwindow, x and y are set to −1.

The getbegyx() macro stores the x and y coordinates of the specified window's origin (upper-left corner).

The getmaxyx() macro stores the numbers of rows in the specified window in y and the number of columns in x.

Parameters

win

Is a pointer to a window.

y

stores the y coordinate for the cursor or origin. The getmaxyx() macro uses it to store the number of rows in the window.

x

stores the x coordinate for the cursor or origin. The getmaxyx() macro uses it to store the number of columns in the window.

Return Values

These macros do not return a value.

Errors

None.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Unsafe
Standard

See Also

libcurses(3XCURSES), attributes(7), standards(7)