doc-ja/reference/pgsql/functions/pg-client-encoding.xml at master · php/doc-ja · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./ja/functions/pgsql.xml, last change in rev 1.5 -->
<!-- EN-Revision: 5f1a92089fa4efe81e9777f87f9ed93f4853898b 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>
    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
-->