Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

getbegyx(3xcurses) [opensolaris man page]

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(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

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

SunOS 5.11							    5 Jun 2002							getbegyx(3XCURSES)

Check Out this Related Man Page

curs_getyx(3CURSES)                                          Curses Library Functions                                          curs_getyx(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(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE         |      ATTRIBUTE VALUE        |
       +-----------------------------+-----------------------------+
       |MT-Level                     |Unsafe                       |
       +-----------------------------+-----------------------------+

SEE ALSO

       curses(3CURSES), attributes(5)

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.

SunOS 5.10                                                          31 Dec 1996                                                curs_getyx(3CURSES)
Man Page