mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-04-01 08:48:56 +00:00
56 lines
1.6 KiB
XML
56 lines
1.6 KiB
XML
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
||
|
|
<!-- $Revision: 1.1 $ -->
|
||
|
|
<refentry id="function.ircg-who">
|
||
|
|
<refnamediv>
|
||
|
|
<refname>ircg_who</refname>
|
||
|
|
<refpurpose>Queries server for WHO information</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsect1>
|
||
|
|
<title>Description</title>
|
||
|
|
<methodsynopsis>
|
||
|
|
<type>bool</type><methodname>ircg_who</methodname>
|
||
|
|
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
|
||
|
|
<methodparam><type>string</type><parameter>mask</parameter></methodparam>
|
||
|
|
<methodparam choice="opt"><type>bool</type><parameter>ops_only</parameter></methodparam>
|
||
|
|
</methodsynopsis>
|
||
|
|
<para>
|
||
|
|
<function>ircg_who</function> will request a list of users
|
||
|
|
whose nickname is matching <parameter>mask</parameter> on connected
|
||
|
|
network <parameter>connection</parameter>. The optional parameter
|
||
|
|
<parameter>ops_only</parameter> will shrink the list to server
|
||
|
|
operators only.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
The answer is sent to the output defined by
|
||
|
|
<function>ircg_set_file</function> or
|
||
|
|
<function>ircg_set_current</function>.
|
||
|
|
&return.success;
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
See also: <function>ircg_set_file</function>, and
|
||
|
|
<function>ircg_set_current</function>.
|
||
|
|
</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
|
||
|
|
-->
|