<!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>Initializes soft label key functions</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-slk-color.html">ncurses_slk_color</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ncurses-slk-noutrefresh.html">ncurses_slk_noutrefresh</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-slk-init" class="refentry">
<div class="refnamediv">
<h1 class="refname">ncurses_slk_init</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_slk_init</span> — <span class="dc-title">Initializes soft label key functions</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ncurses-slk-init-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ncurses_slk_init</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$format</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">
Initializes soft label key functions
</p>
<p class="para">
This function must be called before <span class="function"><a href="function.ncurses-init.html" class="function">ncurses_init()</a></span>
or <span class="function"><a href="function.ncurses-newwin.html" class="function">ncurses_newwin()</a></span> is called.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ncurses-slk-init-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">format</code></em></span>
<dd>
<p class="para">
If <span class="function"><a href="function.ncurses-init.html" class="function">ncurses_init()</a></span> eventually uses a line from
stdscr to emulate the soft labels, then this parameter determines how
the labels are arranged of the screen.
</p>
<p class="para">
0 indicates a 3-2-3 arrangement of the labels, 1 indicates a 4-4
arrangement and 2 indicates the PC like 4-4-4 mode, but in addition an
index line will be created.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ncurses-slk-init-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><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-slk-color.html">ncurses_slk_color</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ncurses-slk-noutrefresh.html">ncurses_slk_noutrefresh</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>
