<!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>Describes an individual dictionary</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.enchant-dict-check.html">enchant_dict_check</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.enchant-dict-get-error.html">enchant_dict_get_error</a></div>
<div class="up"><a href="ref.enchant.html">Enchant Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.enchant-dict-describe" class="refentry">
<div class="refnamediv">
<h1 class="refname">enchant_dict_describe</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL enchant >= 0.1.0 )</p><p class="refpurpose"><span class="refname">enchant_dict_describe</span> — <span class="dc-title">Describes an individual dictionary</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.enchant-dict-describe-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>enchant_dict_describe</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dict</code></span>
)</div>
<p class="para rdfs-comment">
Returns the details of the dictionary.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.enchant-dict-describe-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">dict</code></em></span>
<dd>
<p class="para">
Dictionary resource
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.enchant-dict-describe-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.enchant-dict-describe-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2467">
<p><strong>Example #1 A <span class="function"><strong>enchant_dict_describe()</strong></span> example</strong></p>
<div class="example-contents"><p>
Check if a dictionary exists using
<span class="function"><a href="function.enchant-broker-dict-exists.html" class="function">enchant_broker_dict_exists()</a></span> and show the detail of it.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$tag </span><span style="color: #007700">= </span><span style="color: #DD0000">'en_US'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$broker </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_broker_init</span><span style="color: #007700">();<br />if (</span><span style="color: #0000BB">enchant_broker_dict_exists</span><span style="color: #007700">(</span><span style="color: #0000BB">$broker</span><span style="color: #007700">,</span><span style="color: #0000BB">$tag</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$dict </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_broker_request_dict</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">, </span><span style="color: #0000BB">$tag</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$dict_details </span><span style="color: #007700">= </span><span style="color: #0000BB">enchant_dict_describe</span><span style="color: #007700">(</span><span style="color: #0000BB">$dict</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$dict_details</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[lang] => en_US
[name] => aspell
[desc] => Aspell Provider
[file] => /usr/lib/enchant/libenchant_aspell.so
)
</pre></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.enchant-dict-check.html">enchant_dict_check</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.enchant-dict-get-error.html">enchant_dict_get_error</a></div>
<div class="up"><a href="ref.enchant.html">Enchant Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
