mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
101 lines
2.8 KiB
XML
101 lines
2.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.7 $ -->
|
|
<refentry xml:id="function.ircg-channel-mode" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ircg_channel_mode</refname>
|
|
<refpurpose>Set channel mode flags for user</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ircg_channel_mode</methodname>
|
|
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>channel</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mode_spec</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>nick</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Set channel mode flags for <parameter>channel</parameter> on
|
|
server connected to by <parameter>connection</parameter>. Mode flags
|
|
are passed in <parameter>mode_spec</parameter> and are applied to
|
|
the user specified by <parameter>nick</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>mode_spec</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The mode to be applied on <parameter>nick</parameter>.
|
|
</para>
|
|
<para>
|
|
Mode flags are set or cleared by specifying a mode character and
|
|
prepending it with a plus or minus character,
|
|
respectively. E.g. operator mode is granted by '+o' and revoked
|
|
by '-o', as passed as <parameter>mode_spec</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>nick</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The user on which to apply the given mode.
|
|
</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
|
|
-->
|