fdf-set-encoding.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.fdf-set-encoding" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fdf_set_encoding</refname>
  <refpurpose>FDF 文字エンコーディングを設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>fdf_set_encoding</methodname>
   <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam>
   <methodparam><type>string</type><parameter>encoding</parameter></methodparam>
  </methodsynopsis>
  <para>
   FDF ドキュメントの文字エンコーディングを設定します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>fdf_document</parameter></term>
     <listitem>
      <para>
       <function>fdf_create</function>、
       <function>fdf_open</function> あるいは <function>fdf_open_string</function>
       が返す FDF ドキュメントハンドル。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      <para>
       エンコーディング名。現在サポートしているのは
       "<literal>Shift-JIS</literal>"、"<literal>UHC</literal>"、
       "<literal>GBK</literal>"、"<literal>BigFive</literal>" です。
      </para>
      <para>
       空の文字列を指定すると、エンコーディングをデフォルトの
       <literal>PDFDocEncoding/Unicode</literal> スキームに設定します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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
-->