<!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>Retrieve internal configuration variables of iconv extension</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.iconv.html">iconv Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.iconv-mime-decode-headers.html">iconv_mime_decode_headers</a></div>
<div class="up"><a href="ref.iconv.html">iconv Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.iconv-get-encoding" class="refentry">
<div class="refnamediv">
<h1 class="refname">iconv_get_encoding</h1>
<p class="verinfo">(PHP 4 >= 4.0.5, PHP 5)</p><p class="refpurpose"><span class="refname">iconv_get_encoding</span> — <span class="dc-title">Retrieve internal configuration variables of iconv extension</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.iconv-get-encoding-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>iconv_get_encoding</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code><span class="initializer"> = "all"</span></span>
] )</div>
<p class="para rdfs-comment">
Retrieve internal configuration variables of iconv extension.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.iconv-get-encoding-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
The value of the optional <em><code class="parameter">type</code></em> can be:
<ul class="simplelist">
<li class="member">all</li>
<li class="member">input_encoding</li>
<li class="member">output_encoding</li>
<li class="member">internal_encoding</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.iconv-get-encoding-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the current value of the internal configuration variable if
successful or <strong><code>FALSE</code></strong> on failure.
</p>
<p class="para">
If <em><code class="parameter">type</code></em> is omitted or set to "all",
<span class="function"><strong>iconv_get_encoding()</strong></span> returns an array that
stores all these variables.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.iconv-get-encoding-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2475">
<p><strong>Example #1 <span class="function"><strong>iconv_get_encoding()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<pre><br /><span style="color: #0000BB"><?php<br />iconv_set_encoding</span><span style="color: #007700">(</span><span style="color: #DD0000">"internal_encoding"</span><span style="color: #007700">, </span><span style="color: #DD0000">"UTF-8"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">iconv_set_encoding</span><span style="color: #007700">(</span><span style="color: #DD0000">"output_encoding"</span><span style="color: #007700">, </span><span style="color: #DD0000">"ISO-8859-1"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">iconv_get_encoding</span><span style="color: #007700">(</span><span style="color: #DD0000">'all'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?><br /></span></pre></span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[input_encoding] => ISO-8859-1
[output_encoding] => ISO-8859-1
[internal_encoding] => UTF-8
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.iconv-get-encoding-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.iconv-set-encoding.html" class="function" rel="rdfs-seeAlso">iconv_set_encoding()</a> - Set current setting for character encoding conversion</span></li>
<li class="member"> <span class="function"><a href="function.ob-iconv-handler.html" class="function" rel="rdfs-seeAlso">ob_iconv_handler()</a> - Convert character encoding as output buffer handler</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.iconv.html">iconv Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.iconv-mime-decode-headers.html">iconv_mime_decode_headers</a></div>
<div class="up"><a href="ref.iconv.html">iconv Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
