Source of: /manual/en/function.ncurses-clrtobot.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ncurses.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ncurses-clrtobot.php',
1 => 'ncurses_clrtobot',
),
'up' =>
array (
0 => 'ref.ncurses.php',
1 => 'Ncurses Functions',
),
'prev' =>
array (
0 => 'function.ncurses-clear.php',
1 => 'ncurses_clear',
),
'next' =>
array (
0 => 'function.ncurses-clrtoeol.php',
1 => 'ncurses_clrtoeol',
),
'alternatives' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ncurses-clrtobot" class="refentry">
<div class="refnamediv">
<h1 class="refname">ncurses_clrtobot</h1>
<p class="verinfo">(PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)</p><p class="refpurpose"><span class="refname">ncurses_clrtobot</span> — <span class="dc-title">Clear screen from current position to bottom </span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ncurses-clrtobot-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ncurses_clrtobot</strong></span>
( <span class="methodparam">void</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">
Erases all lines from cursor to end of screen and creates blanks. Blanks
created by <span class="function"><strong>ncurses_clrtobot()</strong></span> have the current
background rendition.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ncurses-clrtobot-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ncurses-clrtobot-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ncurses-clear.php" class="function" rel="rdfs-seeAlso">ncurses_clear()</a> - Clear screen</span></li>
<li class="member"> <span class="function"><a href="function.ncurses-clrtoeol.php" class="function" rel="rdfs-seeAlso">ncurses_clrtoeol()</a> - Clear screen from current position to end of line</span></li>
</ul>
</p>
</div>
</div><?php manual_footer(); ?>
