php-doc-en/reference/fdf/functions/fdf-set-encoding.xml
Mehdi Achour f6988d2720 ref.fdf: switch to new docstyle
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@230199 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-19 00:04:50 +00:00

80 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.fdf-set-encoding">
<refnamediv>
<refname>fdf_set_encoding</refname>
<refpurpose>Sets FDF character encoding</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>
Sets the character encoding for the FDF document.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fdf_document</parameter></term>
<listitem>
<para>
The FDF document handle, returned by <function>fdf_create</function>,
<function>fdf_open</function> or <function>fdf_open_string</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The encoding name. The following values are supported:
"<literal>Shift-JIS</literal>", "<literal>UHC</literal>",
"<literal>GBK</literal>" and "<literal>BigFive</literal>".
</para>
<para>
An empty string resets the encoding to the default
<literal>PDFDocEncoding/Unicode</literal> scheme.
</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:"../../../../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
-->