'\" te
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
.TH curs_getyx 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
.SH NAME
curs_getyx, getyx, getparyx, getbegyx, getmaxyx \- get curses cursor and window coordinates
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
#include <curses.h>

\fBvoid\fR \fBgetyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.LP
.nf
\fBvoid\fR \fBgetparyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.LP
.nf
\fBvoid\fR \fBgetbegyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.LP
.nf
\fBvoid\fR \fBgetmaxyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.SH DESCRIPTION
.sp
.LP
With the \fBgetyx()\fR macro, the cursor position of the window is placed in the two integer variables \fIy\fR and \fIx\fR.
.sp
.LP
With the \fBgetparyx()\fR macro, if \fIwin\fR is a subwindow, the beginning coordinates of the subwindow relative to the parent window are placed into two integer variables, \fIy\fR and \fIx\fR. Otherwise, \fB\(mi1\fR is placed into \fIy\fR and \fIx\fR.
.sp
.LP
Like \fBgetyx()\fR \fB,\fR the \fBgetbegyx()\fR and \fBgetmaxyx()\fR macros store the current beginning coordinates and size of the specified window.
.SH RETURN VALUES
.sp
.LP
The return values of these macros are undefined (that is, they should not be used as the right-hand side of assignment statements).
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelUnsafe
.TE

.SH SEE ALSO
.sp
.LP
\fBcurses\fR(3CURSES), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR> and <\fBunctrl.h\fR>.
.sp
.LP
Note that all of these interfaces are macros and that ``\fB&\fR\&'' is not necessary before the variables \fIy\fR and \fIx\fR.