<!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>Set 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-send-query.html">pg_send_query</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pg-set-error-verbosity.html">pg_set_error_verbosity</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-set-client-encoding" class="refentry"> <div class="refnamediv"> <h1 class="refname">pg_set_client_encoding</h1> <p class="verinfo">(PHP 4 >= 4.0.3, PHP 5)</p><p class="refpurpose"><span class="refname">pg_set_client_encoding</span> — <span class="dc-title"> Set the client encoding </span></p> </div> <div class="refsect1 description" id="refsect1-function.pg-set-client-encoding-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><strong>pg_set_client_encoding</strong></span> ([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span> ], <span class="methodparam"><span class="type">string</span> <code class="parameter">$encoding</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>pg_set_client_encoding()</strong></span> sets the client encoding and returns 0 if success or -1 if error. </p> <p class="para"> PostgreSQL will automatically convert data in the backend database encoding into the frontend encoding. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> The function used to be called <span class="function"><strong>pg_setclientencoding()</strong></span>. </p> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-function.pg-set-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> <dt> <span class="term"><em><code class="parameter">encoding</code></em></span> <dd> <p class="para"> The required client encoding. One of <em>SQL_ASCII</em>, <em>EUC_JP</em>, <em>EUC_CN</em>, <em>EUC_KR</em>, <em>EUC_TW</em>, <em>UNICODE</em>, <em>MULE_INTERNAL</em>, <em>LATINX</em> (X=1...9), <em>KOI8</em>, <em>WIN</em>, <em>ALT</em>, <em>SJIS</em>, <em>BIG5</em> or <em>WIN1250</em>. </p> <p class="para"> The exact list of available encodings depends on your PostgreSQL version, so check your PostgreSQL manual for a more specific list. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.pg-set-client-encoding-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns 0 on success or -1 on error. </p> </div> <div class="refsect1 examples" id="refsect1-function.pg-set-client-encoding-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2121"> <p><strong>Example #1 <span class="function"><strong>pg_set_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 /><br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_pconnect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=publisher"</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"An error occurred.\n"</span><span style="color: #007700">;<br /> exit;<br />}<br /><br /></span><span style="color: #FF8000">// Set the client encoding to UNICODE. Data will be automatically<br />// converted from the backend encoding to the frontend.<br /></span><span style="color: #0000BB">pg_set_client_encoding</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"UNICODE"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT author, email FROM authors"</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"An error occurred.\n"</span><span style="color: #007700">;<br /> exit;<br />}<br /><br /></span><span style="color: #FF8000">// Write out UTF-8 data<br /></span><span style="color: #007700">while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_fetch_row</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Author: </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]</span><span style="color: #DD0000"> E-mail: </span><span style="color: #0000BB">$row</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">]</span><span style="color: #DD0000">"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br />}<br /> <br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.pg-set-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-client-encoding.html" class="function" rel="rdfs-seeAlso">pg_client_encoding()</a> - Gets 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-send-query.html">pg_send_query</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.pg-set-error-verbosity.html">pg_set_error_verbosity</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>