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>InspIRCd: command_t class Reference</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3.3 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
8 <h1>command_t Class Reference</h1>A structure that defines a command.
9 <a href="#_details">More...</a>
11 <code>#include <<a class="el" href="ctables_8h-source.html">ctables.h</a>></code>
13 Inherits <a class="el" href="classExtensible.html">Extensible</a>.
15 <a href="classcommand__t-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
17 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
18 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o0">command</a> [MAXBUF]</td></tr>
20 <tr><td class="mdescLeft"> </td><td class="mdescRight">Command name. </em> <a href="#o0"></a><em><br><br></td></tr>
21 <tr><td class="memItemLeft" nowrap align=right valign=top>handlerfunc * </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o1">handler_function</a></td></tr>
23 <tr><td class="mdescLeft"> </td><td class="mdescRight">Handler function as in typedef. </em> <a href="#o1"></a><em><br><br></td></tr>
24 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o2">flags_needed</a></td></tr>
26 <tr><td class="mdescLeft"> </td><td class="mdescRight">User flags needed to execute the command or 0. </em> <a href="#o2"></a><em><br><br></td></tr>
27 <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o3">min_params</a></td></tr>
29 <tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum number of parameters command takes. </em> <a href="#o3"></a><em><br><br></td></tr>
30 <tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o4">use_count</a></td></tr>
32 <tr><td class="mdescLeft"> </td><td class="mdescRight">used by /stats m </em> <a href="#o4"></a><em><br><br></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o5">total_bytes</a></td></tr>
35 <tr><td class="mdescLeft"> </td><td class="mdescRight">used by /stats m </em> <a href="#o5"></a><em><br><br></td></tr>
37 <hr><a name="_details"></a><h2>Detailed Description</h2>
38 A structure that defines a command.
42 Definition at line <a class="el" href="ctables_8h-source.html#l00026">26</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.<hr><h2>Member Data Documentation</h2>
43 <a name="o0" doxytag="command_t::command"></a><p>
44 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
47 <table cellpadding="0" cellspacing="0" border="0">
49 <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o0">command_t::command</a>[MAXBUF]
54 <table cellspacing=5 cellpadding=0 border=0>
66 Definition at line <a class="el" href="ctables_8h-source.html#l00031">31</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td>
69 <a name="o2" doxytag="command_t::flags_needed"></a><p>
70 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
73 <table cellpadding="0" cellspacing="0" border="0">
75 <td class="md" nowrap valign="top"> char <a class="el" href="classcommand__t.html#o2">command_t::flags_needed</a>
80 <table cellspacing=5 cellpadding=0 border=0>
88 User flags needed to execute the command or 0.
92 Definition at line <a class="el" href="ctables_8h-source.html#l00037">37</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td>
95 <a name="o1" doxytag="command_t::handler_function"></a><p>
96 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
99 <table cellpadding="0" cellspacing="0" border="0">
101 <td class="md" nowrap valign="top"> handlerfunc* <a class="el" href="classcommand__t.html#o1">command_t::handler_function</a>
106 <table cellspacing=5 cellpadding=0 border=0>
114 Handler function as in typedef.
118 Definition at line <a class="el" href="ctables_8h-source.html#l00034">34</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td>
121 <a name="o3" doxytag="command_t::min_params"></a><p>
122 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
125 <table cellpadding="0" cellspacing="0" border="0">
127 <td class="md" nowrap valign="top"> int <a class="el" href="classcommand__t.html#o3">command_t::min_params</a>
132 <table cellspacing=5 cellpadding=0 border=0>
140 Minimum number of parameters command takes.
144 Definition at line <a class="el" href="ctables_8h-source.html#l00040">40</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td>
147 <a name="o5" doxytag="command_t::total_bytes"></a><p>
148 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
151 <table cellpadding="0" cellspacing="0" border="0">
153 <td class="md" nowrap valign="top"> long <a class="el" href="classcommand__t.html#o5">command_t::total_bytes</a>
158 <table cellspacing=5 cellpadding=0 border=0>
170 Definition at line <a class="el" href="ctables_8h-source.html#l00046">46</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td>
173 <a name="o4" doxytag="command_t::use_count"></a><p>
174 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
177 <table cellpadding="0" cellspacing="0" border="0">
179 <td class="md" nowrap valign="top"> long <a class="el" href="classcommand__t.html#o4">command_t::use_count</a>
184 <table cellspacing=5 cellpadding=0 border=0>
196 Definition at line <a class="el" href="ctables_8h-source.html#l00043">43</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td>
199 <hr>The documentation for this class was generated from the following file:<ul>
200 <li><a class="el" href="ctables_8h-source.html">ctables.h</a></ul>
201 <hr size="1"><address style="align: right;"><small>Generated on Mon Mar 28 21:09:30 2005 for InspIRCd by
202 <a href="http://www.doxygen.org/index.html">
203 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
204 </a>1.3.3 </small></address>