summaryrefslogtreecommitdiff
path: root/docs/module-doc/classcommand__t.html
blob: dfb34a90a211dbcdd1ee9d429eace0a7caf9ff4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>command_t class Reference</title>
<link href="inspircd.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc3 -->
<center>
<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>
<hr><h1>command_t Class Reference</h1>A structure that defines a command. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ctables_8h-source.html">ctables.h</a>&gt;</code>
<p>
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>
<map name="command__t__inherit__map">
<area href="classExtensible.html" shape="rect" coords="11,85,80,106" alt="">
<area href="classclassbase.html" shape="rect" coords="12,16,79,37" alt="">
</map>
<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>
<map name="command__t__coll__map">
<area href="classExtensible.html" shape="rect" coords="28,8,97,29" alt="">
</map>
<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>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<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>
<tr><td>&nbsp;</td><td><font size=-1><em>Command name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A structure that defines a command.
<p>

<p>
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>
<a name="m0" doxytag="command_t::command"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> char command_t::command[MAXBUF]
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Command name.
<p>

<p>
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>
  </tr>
</table>
<a name="m2" doxytag="command_t::flags_needed"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> char command_t::flags_needed
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
User flags needed to execute the command or 0.
<p>

<p>
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>
  </tr>
</table>
<a name="m1" doxytag="command_t::handler_function"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> handlerfunc* command_t::handler_function
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Handler function as in typedef.
<p>

<p>
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>
  </tr>
</table>
<a name="m3" doxytag="command_t::min_params"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int command_t::min_params
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Minimum number of parameters command takes.
<p>

<p>
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>
  </tr>
</table>
<a name="m5" doxytag="command_t::total_bytes"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> long command_t::total_bytes
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
used by /stats m
<p>

<p>
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>
  </tr>
</table>
<a name="m4" doxytag="command_t::use_count"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> long command_t::use_count
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
used by /stats m
<p>

<p>
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>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ctables_8h-source.html">ctables.h</a></ul>
<hr><address style="align: right;"><small>Generated on Thu Apr 29 16:30:46 2004 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.3-rc3 </small></address>
</body>
</html>