cvs: phpdoc /de/functions ircg.xml

georg Tue Jan 1 15:57:02 2002 EDT Modified files: /phpdoc/de/functions ircg.xml Log: added documentation for new ircg-functions updated to en rev. 1.20 Index: phpdoc/de/functions/ircg.xml diff -u phpdoc/de/functions/ircg.xml:1.3 phpdoc/de/functions/ircg.xml:1.4 --- phpdoc/de/functions/ircg.xml:1.3 Wed Dec 12 15:46:12 2001 +++ phpdoc/de/functions/ircg.xml Tue Jan 1 15:57:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <reference id="ref.ircg"> <title>IRC Gateway Functions</title> <titleabbrev>IRC Gateway</titleabbrev> @@ -158,7 +158,7 @@ </refpurpose> </refnamediv> <refsect1> - <title>Description</title> + <title>Beschreibung</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>ircg_part</function></funcdef> @@ -418,7 +418,7 @@ </refpurpose> </refnamediv> <refsect1> - <title>Description</title> + <title>Beschreibung</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>ircg_ignore_del</function></funcdef> @@ -582,6 +582,140 @@ </para> </refsect1> </refentry> + + <refentry id='function.ircg-set-on-die'> + <refnamediv> + <refname>ircg_set_on_die</refname> + <refpurpose> + Setzt eine Aktion bei Abbruch der Verbindung + </refpurpose> + </refnamediv> + <refsect1> + <title>Beschreibung</title> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>ircg_set_on_die</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>host</parameter></paramdef> + <paramdef>int <parameter>port</parameter></paramdef> + <paramdef>string <parameter>data</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Im Falle eines Verbindungsabruchs der Verbindung + <parameter>connection</parameter> sendet + <function>ircg_set_on_die</function> auf einem Irc-Server, der über + <parameter>host</parameter> und <parameter>port</parameter> + (Hinweis, der Parameter <parameter>host</parameter> muss eine + gültige IPv4-Adresse enthalten) angegeben wird, + die Zeichenkette <parameter>data</parameter>. + </para> + </refsect1> + </refentry> + + <refentry id='function.ircg-set-file'> + <refnamediv> + <refname>ircg_set_file</refname> + <refpurpose> + Legt eine Logdatei an + </refpurpose> + </refnamediv> + <refsect1> + <title>Beschreibung</title> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>ircg_set_file</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>path</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Die Funktion <function>ircg_set_file</function> legt eine + Logdatei <parameter>path</parameter> für die Verbindung + <parameter>connection</parameter> an, in der alle Ausgaben + geloggt werden. <function>ircg_set_file</function> liefert bei + Auftreten eines Fehler &false; zurück, ansonsten &true;. + </para> + </refsect1> + </refentry> + + <refentry id='function.ircg-get-username'> + <refnamediv> + <refname>ircg_get_username</refname> + <refpurpose> + Liefert den Benutzernamen zurück + </refpurpose> + </refnamediv> + <refsect1> + <title>Beschreibung</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ircg_get_username</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Die Funktion <function>ircg_get_username</function> liefert den + aktuellen Benutzernamen für die Verbindung + <parameter>connection</parameter> zurück. Ist die Verbindung + ungültig, oder wurde die Verbindung abgebrochen, liefert + <function>ircg_get_username</function> &false; zurück. + </para> + </refsect1> + </refentry> + + <refentry id='function.ircg-nickname-escape'> + <refnamediv> + <refname>ircg_nickname_escape</refname> + <refpurpose> + Formatiert einen Benutzernamen in einen gültigen IRC-Namen + </refpurpose> + </refnamediv> + <refsect1> + <title>Beschreibung</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ircg_nickname_escape</function></funcdef> + <paramdef>string <parameter>nick</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Die Funktion <function>ircg_nickname_escape</function> formatiert + einen Benutzernamen <parameter>nick</parameter> in einen IRC + konformes Format, und liefert den umgewandelten Namen zurück. + </para> + <para> + Siehe auch: <function>ircg_nickname_unescape</function> + </para> + </refsect1> + </refentry> + + <refentry id='function.ircg-nickname-unescape'> + <refnamediv> + <refname>ircg_nickname_unescape</refname> + <refpurpose> + Decodiert einen IRC konformen Benutzernamen + </refpurpose> + </refnamediv> + <refsect1> + <title>Beschreibung</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>ircg_nickname_unescape</function></funcdef> + <paramdef>string <parameter>nick</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Function <function>ircg_nickname_unescape</function> liefert + einen decodierten Benutzernamen zurück, der über den Parameter + <parameter>nick</parameter> übergeben wurde. + </para> + <para> + Siehe auch: <function>ircg_nickname_escape</function> + </para> + </refsect1> + </refentry> + </reference>