bind-textdomain-codeset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 679cf93fa1e54cde82fc9cf545966eb13bcb0638 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu,jdkfx -->
<refentry xml:id="function.bind-textdomain-codeset" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bind_textdomain_codeset</refname>
  <refpurpose>DOMAIN メッセージカタログから返されるメッセージの文字エンコーディングを設定/取得する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>bind_textdomain_codeset</methodname>
   <methodparam><type>string</type><parameter>domain</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>codeset</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>bind_textdomain_codeset</function> を使用することで、
   <function>gettext</function> やその類似の関数において返される、
   <parameter>domain</parameter> からのメッセージの文字エンコーディングを
   設定したり、取得することが可能です。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>domain</parameter></term>
     <listitem>
      <para>
       ドメイン。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>codeset</parameter></term>
     <listitem>
      <para>
       コードセット。
       &null; を指定すると、現在設定されているエンコーディングが返されます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   <parameter>domain</parameter> が空の <type>string</type> である場合、
   <exceptionname>ValueError</exceptionname> をスローします。
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       <parameter>domain</parameter> が空の <type>string</type> である場合、
       <exceptionname>ValueError</exceptionname> をスローするようになりました。
      </entry>
     </row>
     <row>
      <entry>8.4.0</entry>
      <entry>
       <parameter>codeset</parameter> パラメータが任意になりました。
       これより前のバージョンでは、常に指定しなければなりませんでした。
      </entry>
     </row>
     <row>
      <entry>8.0.3</entry>
      <entry>
       <parameter>codeset</parameter> は、nullable になりました。
       これより前のバージョンでは、
       現在設定されているエンコーディングは取得できませんでした。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>bind_textdomain_codeset</function> 関数の情報はプロセス単位で管理されます。
    スレッドではありません。
   </para>
  </note>
 </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
-->