mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
61f9667d99
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@116157 c90b9560-bf6c-de11-be94-00142212c4b1
58 lines
2 KiB
XML
58 lines
2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.4 $ -->
|
|
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
|
|
<refentry id="function.ircg-msg">
|
|
<refnamediv>
|
|
<refname>ircg_msg</refname>
|
|
<refpurpose>
|
|
Send message to channel or user on server
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ircg_msg</methodname>
|
|
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>recipient</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>message</parameter></methodparam>
|
|
<methodparam choice="opt"><type>boolean</type><parameter>suppress</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ircg_msg</function> will send the message to a channel
|
|
or user on the server connected to by
|
|
<parameter>connection</parameter>. A
|
|
<parameter>recipient</parameter> starting with
|
|
<literal>#</literal> or <literal>&</literal> will send the
|
|
<parameter>message</parameter> to a channel, anything else will
|
|
be interpreted as a username.
|
|
</para>
|
|
<para>
|
|
Setting the optional parameter <parameter>suppress</parameter> to
|
|
a &true; value will suppress output of your message to your own
|
|
<parameter>connection</parameter>. This so-called loopback is
|
|
necessary, because the IRC server does not echo PRIVMSG commands
|
|
back to us.
|
|
</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
|
|
-->
|