<!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>Change the mode number of suggestions returned</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-config-ignore.html">pspell_config_ignore</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-config-personal.html">pspell_config_personal</a></div>
<div class="up"><a href="ref.pspell.html">Pspell Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.pspell-config-mode" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_config_mode</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">pspell_config_mode</span> — <span class="dc-title">Change the mode number of suggestions returned</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pspell-config-mode-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>pspell_config_mode</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$dictionary_link</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span>
)</div>
<p class="simpara">
<span class="function"><strong>pspell_config_mode()</strong></span> should be used on a config
before calling <span class="function"><a href="function.pspell-new-config.html" class="function">pspell_new_config()</a></span>. This function
determines how many suggestions will be returned by
<span class="function"><a href="function.pspell-suggest.html" class="function">pspell_suggest()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pspell-config-mode-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">dictionary_link</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The mode parameter is the mode in which spellchecker will work.
There are several modes available:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_FAST</code></strong> - Fast mode (least number of
suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_NORMAL</code></strong> - Normal mode (more suggestions)
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>PSPELL_BAD_SPELLERS</code></strong> - Slow mode (a lot of
suggestions)
</span>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pspell-config-mode-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 examples" id="refsect1-function.pspell-config-mode-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2730">
<p><strong>Example #1 <span class="function"><strong>pspell_config_mode()</strong></span> Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$pspell_config </span><span style="color: #007700">= </span><span style="color: #0000BB">pspell_config_create</span><span style="color: #007700">(</span><span style="color: #DD0000">"en"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">pspell_config_mode</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #0000BB">PSPELL_FAST</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pspell_link </span><span style="color: #007700">= </span><span style="color: #0000BB">pspell_new_config</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">pspell_check</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_link</span><span style="color: #007700">, </span><span style="color: #DD0000">"thecat"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-config-ignore.html">pspell_config_ignore</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-config-personal.html">pspell_config_personal</a></div>
<div class="up"><a href="ref.pspell.html">Pspell Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
