php-doc-en/reference/ircg/functions/ircg-fetch-error-msg.xml
2003-12-15 16:55:22 +00:00

66 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.7 -->
<refentry id="function.ircg-fetch-error-msg">
<refnamediv>
<refname>ircg_fetch_error_msg</refname>
<refpurpose>
Returns the error from previous IRCG operation
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ircg_fetch_error_msg</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>ircg_fetch_error_msg</function> returns the error from
a failed connection.
</para>
<note>
<para>
Error code is stored in first array element, error text in second.
The error code is equivalent to IRC reply codes as defined by
RFC 2812.
</para>
</note>
<para>
<example>
<title><function>ircg_fetch_error_msg</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
if (!ircg_join ($id, "#php")) {
$error = ircg_fetch_error_msg($id);
echo "Can't join channel #php. Error code:
$error[0] Description: $error[1]";
}
?>
]]>
</programlisting>
</example>
</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
-->