docs/module-doc/classcommand__t.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>command_t class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc2 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
   9 <hr><h1>command_t Class Reference</h1>A structure that defines a command.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="ctables_8h-source.html">ctables.h</a>&gt;</code>
  13 <p>
  14 <p>Inheritance diagram for command_t:
  15 <p><center><img src="classcommand__t.png" usemap="#command_t_map" border="0" alt=""></center>
  16 <map name="command_t_map">
  17 <area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,75,24">
  18 </map>
  19 <a href="classcommand__t-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  20 <tr><td></td></tr>
  21 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  22 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m0">command</a> [MAXBUF]</td></tr>
  23 <tr><td>&nbsp;</td><td><font size=-1><em>Command name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
  24 <tr><td nowrap align=right valign=top><a class="el" href="ctables_8h.html#a0">handlerfunc</a> *&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m1">handler_function</a></td></tr>
  25 <tr><td>&nbsp;</td><td><font size=-1><em>Handler function as in typedef.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
  26 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m2">flags_needed</a></td></tr>
  27 <tr><td>&nbsp;</td><td><font size=-1><em>User flags needed to execute the command or 0.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
  28 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m3">min_params</a></td></tr>
  29 <tr><td>&nbsp;</td><td><font size=-1><em>Minimum number of parameters command takes.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
  30 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m4">use_count</a></td></tr>
  31 <tr><td>&nbsp;</td><td><font size=-1><em>used by /stats m</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
  32 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m5">total_bytes</a></td></tr>
  33 <tr><td>&nbsp;</td><td><font size=-1><em>used by /stats m</em> <a href="#m5"></a><em></em></font><br><br></td></tr>
  34 </table>
  35 <hr><a name="_details"></a><h2>Detailed Description</h2>
  36 A structure that defines a command.
  37 <p>
  38
  39 <p>
  40 Definition at line <a class="el" href="ctables_8h-source.html#l00027">27</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.<hr><h2>Member Data Documentation</h2>
  41 <a name="m0" doxytag="command_t::command"></a><p>
  42 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  43   <tr>
  44     <td class="md">
  45       <table cellpadding="0" cellspacing="0" border="0">
  46         <tr>
  47           <td class="md" nowrap valign="top"> char command_t::command[MAXBUF]
  48       </table>
  49     </td>
  50   </tr>
  51 </table>
  52 <table cellspacing=5 cellpadding=0 border=0>
  53   <tr>
  54     <td>
  55       &nbsp;
  56     </td>
  57     <td>
  58
  59 <p>
  60 Command name.
  61 <p>
  62
  63 <p>
  64 Definition at line <a class="el" href="ctables_8h-source.html#l00032">32</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
  65   </tr>
  66 </table>
  67 <a name="m2" doxytag="command_t::flags_needed"></a><p>
  68 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  69   <tr>
  70     <td class="md">
  71       <table cellpadding="0" cellspacing="0" border="0">
  72         <tr>
  73           <td class="md" nowrap valign="top"> char command_t::flags_needed
  74       </table>
  75     </td>
  76   </tr>
  77 </table>
  78 <table cellspacing=5 cellpadding=0 border=0>
  79   <tr>
  80     <td>
  81       &nbsp;
  82     </td>
  83     <td>
  84
  85 <p>
  86 User flags needed to execute the command or 0.
  87 <p>
  88
  89 <p>
  90 Definition at line <a class="el" href="ctables_8h-source.html#l00038">38</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
  91   </tr>
  92 </table>
  93 <a name="m1" doxytag="command_t::handler_function"></a><p>
  94 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  95   <tr>
  96     <td class="md">
  97       <table cellpadding="0" cellspacing="0" border="0">
  98         <tr>
  99           <td class="md" nowrap valign="top"> <a class="el" href="ctables_8h.html#a0">handlerfunc</a>* command_t::handler_function
 100       </table>
 101     </td>
 102   </tr>
 103 </table>
 104 <table cellspacing=5 cellpadding=0 border=0>
 105   <tr>
 106     <td>
 107       &nbsp;
 108     </td>
 109     <td>
 110
 111 <p>
 112 Handler function as in typedef.
 113 <p>
 114
 115 <p>
 116 Definition at line <a class="el" href="ctables_8h-source.html#l00035">35</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
 117   </tr>
 118 </table>
 119 <a name="m3" doxytag="command_t::min_params"></a><p>
 120 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 121   <tr>
 122     <td class="md">
 123       <table cellpadding="0" cellspacing="0" border="0">
 124         <tr>
 125           <td class="md" nowrap valign="top"> int command_t::min_params
 126       </table>
 127     </td>
 128   </tr>
 129 </table>
 130 <table cellspacing=5 cellpadding=0 border=0>
 131   <tr>
 132     <td>
 133       &nbsp;
 134     </td>
 135     <td>
 136
 137 <p>
 138 Minimum number of parameters command takes.
 139 <p>
 140
 141 <p>
 142 Definition at line <a class="el" href="ctables_8h-source.html#l00041">41</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
 143   </tr>
 144 </table>
 145 <a name="m5" doxytag="command_t::total_bytes"></a><p>
 146 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 147   <tr>
 148     <td class="md">
 149       <table cellpadding="0" cellspacing="0" border="0">
 150         <tr>
 151           <td class="md" nowrap valign="top"> long command_t::total_bytes
 152       </table>
 153     </td>
 154   </tr>
 155 </table>
 156 <table cellspacing=5 cellpadding=0 border=0>
 157   <tr>
 158     <td>
 159       &nbsp;
 160     </td>
 161     <td>
 162
 163 <p>
 164 used by /stats m
 165 <p>
 166
 167 <p>
 168 Definition at line <a class="el" href="ctables_8h-source.html#l00047">47</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
 169   </tr>
 170 </table>
 171 <a name="m4" doxytag="command_t::use_count"></a><p>
 172 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 173   <tr>
 174     <td class="md">
 175       <table cellpadding="0" cellspacing="0" border="0">
 176         <tr>
 177           <td class="md" nowrap valign="top"> long command_t::use_count
 178       </table>
 179     </td>
 180   </tr>
 181 </table>
 182 <table cellspacing=5 cellpadding=0 border=0>
 183   <tr>
 184     <td>
 185       &nbsp;
 186     </td>
 187     <td>
 188
 189 <p>
 190 used by /stats m
 191 <p>
 192
 193 <p>
 194 Definition at line <a class="el" href="ctables_8h-source.html#l00044">44</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
 195   </tr>
 196 </table>
 197 <hr>The documentation for this class was generated from the following file:<ul>
 198 <li><a class="el" href="ctables_8h-source.html">ctables.h</a></ul>
 199 <hr><address style="align: right;"><small>Generated on Sun Feb 9 12:48:17 2003 for InspIRCd by
 200 <a href="http://www.doxygen.org/index.html">
 201 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 202 width=110 height=53></a>1.3-rc2 </small></address>
 203 </body>
 204 </html>