<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.0 $ -->
<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>
  <simpara>
   <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.
 </simpara>
 <simpara>
   The answer is sent to the
   output defined by <function>ircg_set_file</function> or
   <function>ircg_set_current</function>.
   &return.success;
  </simpara>
  <simpara>
   See also: <function>ircg_set_file</function> and
   <function>ircg_set_current</function>.
  </simpara>
 </refsect1>
</refentry>