<!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>Gets the client encoding</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-cancel-query.html">pg_cancel_query</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-close.html">pg_close</a></div>
<div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.pg-client-encoding" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_client_encoding</h1>
<p class="verinfo">(PHP 4 >= 4.0.3, PHP 5)</p><p class="refpurpose"><span class="refname">pg_client_encoding</span> — <span class="dc-title">
Gets the client encoding
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-client-encoding-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>pg_client_encoding</strong></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
] )</div>
<p class="para rdfs-comment">
PostgreSQL supports automatic character set conversion between
server and client for certain character sets.
<span class="function"><strong>pg_client_encoding()</strong></span> returns the client
encoding as a string. The returned string will be one of the
standard PostgreSQL encoding identifiers.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function requires PHP 4.0.3 or higher and PostgreSQL 7.0 or
higher. If libpq is compiled without multibyte encoding support,
<span class="function"><strong>pg_client_encoding()</strong></span> always returns
<em>SQL_ASCII</em>. Supported encoding depends on PostgreSQL
version. Refer to the PostgreSQL Documentation supported encodings.
</p>
<p class="para">
The function used to be called <span class="function"><strong>pg_clientencoding()</strong></span>.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-client-encoding-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
PostgreSQL database connection resource. When
<em><code class="parameter">connection</code></em> is not present, the default connection
is used. The default connection is the last connection made by
<span class="function"><a href="function.pg-connect.html" class="function">pg_connect()</a></span> or <span class="function"><a href="function.pg-pconnect.html" class="function">pg_pconnect()</a></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-client-encoding-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The client encoding, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-client-encoding-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2047">
<p><strong>Example #1 <span class="function"><strong>pg_client_encoding()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Assume $conn is a connection to a ISO-8859-1 database<br /></span><span style="color: #0000BB">$encoding </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_client_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Client encoding is: "</span><span style="color: #007700">, </span><span style="color: #0000BB">$encoding</span><span style="color: #007700">, </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</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>
Client encoding is: ISO-8859-1
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pg-client-encoding-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.pg-set-client-encoding.html" class="function" rel="rdfs-seeAlso">pg_set_client_encoding()</a> - Set the client encoding</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="function.pg-cancel-query.html">pg_cancel_query</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-close.html">pg_close</a></div>
<div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
