<!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>Returns a character set object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysqli.field-count.html">mysqli::$field_count</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli.get-client-info.html">mysqli::get_client_info</a></div>
<div class="up"><a href="class.mysqli.html">mysqli</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysqli.get-charset" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysqli::get_charset</h1>
<h1 class="refname">mysqli_get_charset</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">mysqli::get_charset</span> -- <span class="refname">mysqli_get_charset</span> — <span class="dc-title">Returns a character set object</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysqli.get-charset-description">
<h3 class="title">Description</h3>
<p class="para">Object oriented style</p>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>mysqli::get_charset</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>mysqli_get_charset</strong></span>
( <span class="methodparam"><span class="type"><a href="class.mysqli.html" class="type mysqli">mysqli</a></span> <code class="parameter">$link</code></span>
)</div>
<p class="para rdfs-comment">
Returns a character set object providing several properties
of the current active character set.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysqli.get-charset-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
link</code></em></span><dd>
<p class="para">Procedural style only: A link identifier
returned by <span class="function"><a href="function.mysqli-connect.html" class="function">mysqli_connect()</a></span> or <span class="function"><a href="mysqli.init.html" class="function">mysqli_init()</a></span>
</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysqli.get-charset-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The function returns a character set object with the following properties:
<dl>
<dt>
<span class="term"><em><code class="parameter">charset</code></em></span>
<dd>
<p class="para">Character set name</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">collation</code></em></span>
<dd>
<p class="para">Collation name</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dir</code></em></span>
<dd>
<p class="para">Directory the charset description was fetched from (?) or "" for built-in character sets</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">min_length</code></em></span>
<dd>
<p class="para">Minimum character length in bytes</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">max_length</code></em></span>
<dd>
<p class="para">Maximum character length in bytes</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">number</code></em></span>
<dd>
<p class="para">Internal character set number</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">state</code></em></span>
<dd>
<p class="para">Character set status (?)</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mysqli.get-charset-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1662">
<p><strong>Example #1 <span class="methodname"><strong>mysqli::get_charset()</strong></span> example</strong></p>
<div class="example-contents"><p>Object oriented style</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $db </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_init</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">real_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">,</span><span style="color: #DD0000">"root"</span><span style="color: #007700">,</span><span style="color: #DD0000">""</span><span style="color: #007700">,</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">get_charset</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>Procedural style</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $db </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_init</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">mysqli_real_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">, </span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">,</span><span style="color: #DD0000">"root"</span><span style="color: #007700">,</span><span style="color: #DD0000">""</span><span style="color: #007700">,</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">get_charset</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above examples will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
object(stdClass)#2 (7) {
["charset"]=>
string(6) "latin1"
["collation"]=>
string(17) "latin1_swedish_ci"
["dir"]=>
string(0) ""
["min_length"]=>
int(1)
["max_length"]=>
int(1)
["number"]=>
int(8)
["state"]=>
int(801)
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mysqli.get-charset-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="mysqli.character-set-name.html" class="function" rel="rdfs-seeAlso">mysqli_character_set_name()</a> - Returns the default character set for the database connection</span></li>
<li class="member"> <span class="function"><a href="mysqli.set-charset.html" class="function" rel="rdfs-seeAlso">mysqli_set_charset()</a> - Sets the default client character set</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="mysqli.field-count.html">mysqli::$field_count</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli.get-client-info.html">mysqli::get_client_info</a></div>
<div class="up"><a href="class.mysqli.html">mysqli</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
