<!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>Create a config used to open a dictionary</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pspell-clear-session.html">pspell_clear_session</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-config-data-dir.html">pspell_config_data_dir</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-create" class="refentry">
<div class="refnamediv">
<h1 class="refname">pspell_config_create</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">pspell_config_create</span> — <span class="dc-title">Create a config used to open a dictionary</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pspell-config-create-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pspell_config_create</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$language</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$spelling</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$jargon</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span>
]]] )</div>
<p class="para rdfs-comment">
Create a config used to open a dictionary.
</p>
<p class="para">
<span class="function"><strong>pspell_config_create()</strong></span> has a very similar syntax to
<span class="function"><a href="function.pspell-new.html" class="function">pspell_new()</a></span>. In fact, using
<span class="function"><strong>pspell_config_create()</strong></span> immediately followed by
<span class="function"><a href="function.pspell-new-config.html" class="function">pspell_new_config()</a></span> will produce the exact same result.
However, after creating a new config, you can also use
<span class="function"><strong>pspell_config_*()</strong></span> functions before calling
<span class="function"><a href="function.pspell-new-config.html" class="function">pspell_new_config()</a></span> to take advantage of some
advanced functionality.
</p>
<p class="para">
For more information and examples, check out inline manual pspell
website:<a href="http://aspell.net/" class="link external">» http://aspell.net/</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pspell-config-create-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">language</code></em></span>
<dd>
<p class="para">
The language parameter is the language code which consists of the
two letter ISO 639 language code and an optional two letter ISO
3166 country code after a dash or underscore.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">spelling</code></em></span>
<dd>
<p class="para">
The spelling parameter is the requested spelling for languages
with more than one spelling such as English. Known values are
'american', 'british', and 'canadian'.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">jargon</code></em></span>
<dd>
<p class="para">
The jargon parameter contains extra information to distinguish
two different words lists that have the same language and
spelling parameters.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">encoding</code></em></span>
<dd>
<p class="para">
The encoding parameter is the encoding that words are expected to
be in. Valid values are 'utf-8', 'iso8859-*', 'koi8-r',
'viscii', 'cp1252', 'machine unsigned 16', 'machine unsigned
32'. This parameter is largely untested, so be careful when
using.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pspell-config-create-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Retuns a pspell config identifier, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pspell-config-create-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2728">
<p><strong>Example #1 <span class="function"><strong>pspell_config_create()</strong></span></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_personal</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #DD0000">"/var/dictionaries/custom.pws"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">pspell_config_repl</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #DD0000">"/var/dictionaries/custom.repl"</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_personal</span><span style="color: #007700">(</span><span style="color: #0000BB">$pspell_config</span><span style="color: #007700">, </span><span style="color: #DD0000">"en"</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-clear-session.html">pspell_clear_session</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pspell-config-data-dir.html">pspell_config_data_dir</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>
