getbegyx(3xcurses)

1getbegyx(3XCURSES)      X/Open Curses Library Functions     getbegyx(3XCURSES)
2
3
4

NAME

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

SYNOPSIS

9       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
10        -R  /usr/xpg4/lib  -lcurses  [ library... ]
11
12       c89 [ flag... ] file... -lcurses [ library... ]
13
14       #include <curses.h>
15
16       void getbegyx(WINDOW *win, int y, int x);
17
18
19       void getmaxyx(WINDOW *win, int y, int x);
20
21
22       void getparyx(WINDOW *win, int y, int x);
23
24
25       void getyx(WINDOW *win, int y, int x);
26
27

DESCRIPTION

29       The  getyx() macro stores the current cursor position of the  specified
30       window in x and y.
31
32
33       The getparyx() macro stores the x and y coordinates  (relative  to  the
34       parent  window)  of the specified window's origin (upper-left  corner).
35       If win does not point to a subwindow, x and y are set to −1.
36
37
38       The getbegyx() macro stores the x and y coordinates  of  the  specified
39       window's origin (upper-left corner).
40
41
42       The getmaxyx() macro stores the numbers of rows in the specified window
43       in y and the number of columns in x.
44

PARAMETERS

46       win    Is a pointer to a window.
47
48
49       y      stores the y coordinate for the  cursor  or  origin.   The  get‐
50              maxyx()  macro  uses it to store the number of rows in the  win‐
51              dow.
52
53
54       x      stores the x coordinate for the  cursor  or  origin.   The  get‐
55              maxyx()  macro  uses  it  to  store the number of columns in the
56              window.
57
58

RETURN VALUES

60       These macros do not return a value.
61

ERRORS

63       None.
64

ATTRIBUTES

66       See attributes(5) for descriptions of the following attributes:
67
68
69
70
71       ┌─────────────────────────────┬─────────────────────────────┐
72       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
73       ├─────────────────────────────┼─────────────────────────────┤
74       │Interface Stability          │Standard                     │
75       ├─────────────────────────────┼─────────────────────────────┤
76       │MT-Level                     │Unsafe                       │
77       └─────────────────────────────┴─────────────────────────────┘
78