Content-type: text/html Man page of curs_getyx

curs_getyx

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

curs_getyx, getyx, getparyx, getbegyx, getmaxyx - Get Curses cursor and window coordinates  

SYNOPSIS

#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 );
 

LIBRARY

Curses Library (libcurses)
 

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

getyx:  XPG4, XPG4-UNIX

getparyx, getbegyx, getmaxyx:  XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.
 

DESCRIPTION

The getyx macro places the cursor position of the window into the two integer variables y and x.

If win is a subwindow, the getparyx macro places the beginning coordinates of the subwindow (relative to the parent window) into the two integer variables y and x. Otherwise; the macro places -1 into y and x.

Like getyx, the getbegyx and getmaxyx macros store the current beginning coordinates and size of the specified window.
 

NOTES

The header file <curses.h> automatically includes the header file <stdio.h>.

All of these interfaces are macros, and applications do not have to specify & before the variables y and x.
 

RETURN VALUES

The return values of these macros are undefined (that is, they should not be used as the right-hand side of an assignment statements).
 

SEE ALSO

Functions: curses(3)

Others: standards(5)


 

Index

NAME
SYNOPSIS
LIBRARY
STANDARDS
DESCRIPTION
NOTES
RETURN VALUES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:41:06 GMT, October 02, 2010