getbegyx(3curses)

getbegyx -- get cursor and window coordinates

Synopsis

cc [options] file -lcurses

#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(3curses) macro stores the cursor position of the specified window in y and x.

The getparyx(3curses) macro, if the specified window is a subwindow, stores in y and x the coordinates of the window's origin relative to its parent window. Otherwise, -1 is stored in y and x.

The getbegyx(3curses) macro stores the absolute screen coordinates of the specified window's origin in y and x.

The getmaxyx(3curses) macro stores the number of rows of the specified window in y and stores the window's number of columns in x.

Return value

No return values are defined.

Errors

No errors are defined.

Usage

These interfaces are macros and the ampersand character (``&'') cannot be used before the y and x arguments.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

curses(4)