php-doc-en/reference/ircg/functions/ircg-invite.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.ircg-invite" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ircg_invite</refname>
  <refpurpose>Invites nickname to channel</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ircg_invite</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>channel</parameter></methodparam>
   <methodparam><type>string</type><parameter>nickname</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>ircg_invite</function> will send an invitation to the
   user <parameter>nickname</parameter>, prompting him to join the given
   <parameter>channel</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       A connection resource handle returned by
       <function>ircg_pconnect</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>channel</parameter></term>
     <listitem>
      <para>
       The channel name as <literal>#name</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>nickname</parameter></term>
     <listitem>
      <para>
       The user nick name.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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
-->