From f6545ca4d4b12886d5f3e6cd9fb916eb6fcb1f34 Mon Sep 17 00:00:00 2001
From: Georg Richter <georg@php.net>
Date: Sun, 26 Aug 2001 23:39:12 +0000
Subject: [PATCH] 1) Changed typo in ircg_pconnect (nicknake -> nickname)

2) Inserted a new function dscription: ircg_fetch_error_msg
   This function still is only available in CVS

Georg


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@56020 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/ircg.xml | 42 +++++++++++++++++++++++++++++++++++++++---
 1 file changed, 39 insertions(+), 3 deletions(-)

diff --git a/functions/ircg.xml b/functions/ircg.xml
index 8494a80a32..518669ef52 100644
--- a/functions/ircg.xml
+++ b/functions/ircg.xml
@@ -1,5 +1,5 @@
 <?xml encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
  <reference id="ref.ircg">
   <title>IRC Gateway Functions</title>
   <titleabbrev>IRC Gateway</titleabbrev>
@@ -39,7 +39,7 @@
     </para>
 		<para>
 		 The only mandatory parameter is <parameter>username</parameter>,
-		 this will set your initial nicknake on the
+		 this will set your initial nickname on the
 		 server. <parameter>server_ip</parameter> and
 			<parameter>server_port</parameter> are optional and default to
 		 <literal>127.0.0.1</literal> and <literal>6667</literal>.
@@ -70,7 +70,43 @@
     </para>
    </refsect1>
   </refentry>
-
+  <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>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>array <function>ircg_fetch_error_msg</function></funcdef>
+      <paramdef>resource <parameter>connection</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+	   <function>ircg_fetch_error_msg</function> 
+       returns the error from the last called ircg function.
+    </para>
+	<note>
+		<para>
+		 Errorcode is stored in first array element, errortext in second.
+		</para>
+	</note>
+    <para>
+     <example>
+       <title><function>ircg_fetch_error_msg</function> example</title>
+       <programlisting role="php">
+if (!ircg_join ($id, "#php")){
+    $error = ircg_fetch_error_msg($id);
+    print ("Can't join channel #php. Errorcode: $error[0] Description: $error[1]");
+}
+       </programlisting>
+      </example>
+     </para> 
+   </refsect1>
+  </refentry>
   <refentry id="function.ircg-set-current">
    <refnamediv>
     <refname>ircg_set_current</refname>