Added the unicode_decode function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@241577 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nick Berard 2007-08-19 07:30:28 +00:00
parent 34b91c844a
commit da7d0f4266

View file

@ -0,0 +1,104 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.unicode-decode">
<refnamediv>
<refname>unicode_decode</refname>
<refpurpose>Convert a binary string into an unicode string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>unicode </type><methodname>unicode_decode</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Convert a binary string encoded in <parameter>encoding</parameter> to a
<type>unicode</type> string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
Try <type>string</type> that is converted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The encoding of <parameter>input</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Conversion flags.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A <type>unicode</type> string or &false; on failure.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Emits a <constant>E_WARNING</constant> level error if a converter cannot
be created for the desired <parameter>encoding</parameter>.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>unicode_encode</function></member>
<member><function>unicode_semantics</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:"../../../../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
-->