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