Added unicode_get_error_mode()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@241623 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nick Berard 2007-08-20 04:48:50 +00:00
parent 973db92b73
commit a8c63e8d09

View file

@ -0,0 +1,91 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.unicode-get-error-mode">
<refnamediv>
<refname>unicode_get_error_mode</refname>
<refpurpose>Get the error mode for strings conversions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>unicode_get_error_mode</methodname>
<methodparam><type>int</type><parameter>direction</parameter></methodparam>
</methodsynopsis>
<para>
Return the current error mode for string conversions in
<parameter>direction</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>direction</parameter></term>
<listitem>
<para>
Get the error mode for conversion <parameter>direction</parameter>. This
can either be <constant>FROM_UNICODE</constant> or
<constant>TO_UNICODE</constant>. See
<function>unicode_set_error_mode</function> for more details.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns one of the error mode constants or &false; on failure.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Emits a <constant>E_WARNING</constant> level error if
<parameter>direction</parameter> is invalid.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>unicode_set_error_mode</function></member>
<member><function>unicode_encode</function></member>
<member><function>unicode_decode</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
-->