xref: /illumos-gate/usr/src/man/man3xcurses/getbegyx.3xcurses (revision f012ee0c3db17469b492c2cf757226f3d7b1ebbc)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
GETBEGYX 3XCURSES "Jun 5, 2002"
NAME
getbegyx, getmaxyx, getparyx, getyx - get cursor or window coordinates
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -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)