<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
  <refentry id="function.mb-decode-numericentity">
   <refnamediv>
    <refname>mb_decode_numericentity</refname>
    <refpurpose>
     Decode HTML numeric string reference to character
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>mb_decode_numericentity</methodname>
      <methodparam><type>string</type><parameter>str</parameter></methodparam>
      <methodparam><type>array</type><parameter>convmap</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
     </methodsynopsis>
    <para>
     Convert numeric string reference of string
     <parameter>str</parameter> in specified block to character. It
     returns converted string.
    </para>
    <para>
     <parameter>convmap</parameter> is array to specifies code area to
     convert.
    </para>
    <para>
     <parameter>encoding</parameter> is character encoding. If it is
     omitted, internal character encoding is used.
    </para>
    <para>
     <example>
      <title><parameter>convmap</parameter> example</title>
      <programlisting role="php">
<![CDATA[
$convmap = array (
   int start_code1, int end_code1, int offset1, int mask1,
   int start_code2, int end_code2, int offset2, int mask2,
   ........
   int start_codeN, int end_codeN, int offsetN, int maskN );
// Specify Unicode value for start_codeN and end_codeN
// Add offsetN to value and take bit-wise 'AND' with maskN, 
// then convert value to numeric string reference.
]]>
      </programlisting>
     </example>
    </para>
    <para>
     See also <function>mb_encode_numericentity</function>.
    </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
-->