php-doc-en/reference/ncurses/functions/ncurses-getmaxyx.xml
2011-07-15 02:10:37 +00:00

84 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ncurses-getmaxyx" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ncurses_getmaxyx</refname>
<refpurpose>Returns the size of a window</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>ncurses_getmaxyx</methodname>
<methodparam><type>resource</type><parameter>window</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">y</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">x</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Gets the horizontal and vertical size of the given
<parameter>window</parameter> into the given variables.
</para>
<para>
Variables must be passed as reference, so they are updated when the user
changes the terminal size.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>window</parameter></term>
<listitem>
<para>
The measured window
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<para>
This will be set to the window height
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
This will be set to the window width
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->