php-doc-en/reference/intl/functions/intl-is-failure.xml
Richard Quadling 1d137d406b W/S tabs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294396 c90b9560-bf6c-de11-be94-00142212c4b1
2010-02-03 14:08:11 +00:00

110 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.intl-is-failure">
<refnamediv>
<refname>intl_is_failure</refname>
<refpurpose>Check whether the given error code indicates failure</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type>
<methodname>intl_is_failure</methodname>
<methodparam><type>int</type><parameter>error_code</parameter></methodparam>
</methodsynopsis>
<para>
<!-- description goes here -->
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>error_code</parameter></term>
<listitem>
<para>
is a value that returned by functions:
<function>intl_get_error_code</function>,
<function>collator_get_error_code</function> .
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; if it the code indicates some failure, and &false;
in case of success or a warning.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>intl_is_failure</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
function check( $err_code )
{
var_export( intl_is_failure( $err_code ) );
echo "\n";
}
check( U_ZERO_ERROR );
check( U_USING_FALLBACK_WARNING );
check( U_ILLEGAL_ARGUMENT_ERROR );
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
false
false
true
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>intl_get_error_code</function></member>
<member><function>collator_get_error_code</function></member>
<member><function>Collator-getErrorCode</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:"~/.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
-->