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