pg-client-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./ja/functions/pgsql.xml, last change in rev 1.5 -->
<!-- EN-Revision: ad618eea48c773ff8768d9d27ea986f81a2a2400 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.pg-client-encoding" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_client_encoding</refname>
  <refpurpose>
   クライアントのエンコーディングを取得する
  </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 は、ある種の文字セットについてはサーバーとクライアントの間の
   自動文字コード変換をサポートしています。
   <function>pg_client_encoding</function> は、クライアントの
   エンコーディングを文字列として返します。返される値は、標準の
   PostgreSQL エンコーディング識別子のなかのひとつとなります。
  </para>
  <note>
   <para>
    この関数を使用するには、PostgreSQL 7.0 以降が必要です。
    libpq がマルチバイトエンコーディングのサポートを有効にせずに
    コンパイルされている場合、<function>pg_client_encoding</function>
    は常に <literal>SQL_ASCII</literal> を返します。サポートされる
    エンコーディングは PostgreSQL のバージョンに依存します。サポートされる
    エンコーディングの詳細については PostgreSQL のドキュメントを参照ください。
   </para>
   <para>
    この関数は、以前は <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>
    クライアントのエンコーディングを返します。
  </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> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_client_encoding</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// $conn の接続先のエンコーディングは ISO-8859-1 であるとする
$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
-->