pg-client-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.16 -->
<refentry xml:id="function.pg-client-encoding" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_client_encoding</refname>
  <refpurpose>
   Gets the client encoding
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;     
  <methodsynopsis>
   <type>string</type><methodname>pg_client_encoding</methodname>
   <methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   PostgreSQL supports automatic character set conversion between 
   server and client for certain character sets.
   <function>pg_client_encoding</function> returns the client
   encoding as a string. The returned string will be one of the
   standard PostgreSQL encoding identifiers.
  </para>
  <note>
   <para>
    This function requires PostgreSQL 7.0 or
    higher. If libpq is compiled without multibyte encoding support,
    <function>pg_client_encoding</function> always returns
    <literal>SQL_ASCII</literal>. Supported encoding depends on PostgreSQL
    version.  Refer to the PostgreSQL Documentation supported encodings.
   </para>
   <para>
    The function used to be called <function>pg_clientencoding</function>.
   </para>
  </note>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection-with-nullable-default;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    The client encoding.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>connection</parameter> is now nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_client_encoding</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Assume $conn is a connection to a ISO-8859-1 database
$encoding = pg_client_encoding($conn);

echo "Client encoding is: ", $encoding, "\n";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Client encoding is: ISO-8859-1
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_set_client_encoding</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->