GETBEGYX(3XCURSES) X/Open Curses Library Functions GETBEGYX(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 | Standard |
+--------------------+-----------------+
|MT-Level | Unsafe |
+--------------------+-----------------+
SEE ALSO
libcurses(3XCURSES),
attributes(7),
standards(7) June 5, 2002 GETBEGYX(3XCURSES)
