<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns the size of a window</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-getch.html">ncurses_getch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ncurses-getmouse.html">ncurses_getmouse</a></div>
<div class="up"><a href="ref.ncurses.html">Ncurses Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ncurses-getmaxyx" class="refentry">
<div class="refnamediv">
<h1 class="refname">ncurses_getmaxyx</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)</p><p class="refpurpose"><span class="refname">ncurses_getmaxyx</span> — <span class="dc-title">Returns the size of a window</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ncurses-getmaxyx-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>ncurses_getmaxyx</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$window</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$y</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$x</code></span>
)</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
<p class="para">
Gets the horizontal and vertical size of the given
<em><code class="parameter">window</code></em> into the given variables.
</p>
<p class="para">
Variables must be passed as reference, so they are updated when the user
changes the terminal size.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ncurses-getmaxyx-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">window</code></em></span>
<dd>
<p class="para">
The measured window
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">y</code></em></span>
<dd>
<p class="para">
This will be set to the window height
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">x</code></em></span>
<dd>
<p class="para">
This will be set to the window width
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ncurses-getmaxyx-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-getch.html">ncurses_getch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ncurses-getmouse.html">ncurses_getmouse</a></div>
<div class="up"><a href="ref.ncurses.html">Ncurses Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
