]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/classchanrec.html
Added new documentation for XLine etc
[user/henk/code/inspircd.git] / docs / module-doc / classchanrec.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>chanrec 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>chanrec Class Reference</h1>Holds all relevent information for a channel. 
10 <a href="#_details">More...</a>
11 <p>
12 <code>#include &lt;<a class="el" href="channels_8h-source.html">channels.h</a>&gt;</code>
13 <p>
14 Inheritance diagram for chanrec:<p><center><img src="classchanrec__inherit__graph.gif" border="0" usemap="#chanrec__inherit__map" alt="Inheritance graph"></center>
15 <map name="chanrec__inherit__map">
16 <area href="classclassbase.html" shape="rect" coords="7,16,73,37" alt="">
17 </map>
18 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for chanrec:<p><center><img src="classchanrec__coll__graph.gif" border="0" usemap="#chanrec__coll__map" alt="Collaboration graph"></center>
19 <map name="chanrec__coll__map">
20 <area href="classclassbase.html" shape="rect" coords="149,91,216,112" alt="">
21 </map>
22 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classchanrec-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 Member Functions</h2></td></tr>
25 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#a0">SetCustomMode</a> (char mode, bool mode_on)</td></tr>
26 <tr><td>&nbsp;</td><td><font size=-1><em>Sets or unsets a custom mode in the channels info.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
27 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#a1">SetCustomModeParam</a> (char mode, char *parameter, bool mode_on)</td></tr>
28 <tr><td>&nbsp;</td><td><font size=-1><em>Sets or unsets the parameters for a custom mode in a channels info.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
29 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#a2">IsCustomModeSet</a> (char mode)</td></tr>
30 <tr><td>&nbsp;</td><td><font size=-1><em>Returns true if a custom mode is set on a channel.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
31 <tr><td nowrap align=right valign=top>std::string&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#a3">GetModeParameter</a> (char mode)</td></tr>
32 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the parameter for a custom mode on a channel.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
33 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#a4">chanrec</a> ()</td></tr>
34 <tr><td>&nbsp;</td><td><font size=-1><em>Creates a channel record and initialises it with default values.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
35 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#a5">~chanrec</a> ()</td></tr>
36 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
37 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m0">name</a> [CHANMAX]</td></tr>
38 <tr><td>&nbsp;</td><td><font size=-1><em>The channels name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
39 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m1">custom_modes</a> [MAXMODES]</td></tr>
40 <tr><td>&nbsp;</td><td><font size=-1><em>Custom modes for the channel.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
41 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m2">topic</a> [MAXBUF]</td></tr>
42 <tr><td>&nbsp;</td><td><font size=-1><em>Channel topic.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
43 <tr><td nowrap align=right valign=top>time_t&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m3">created</a></td></tr>
44 <tr><td>&nbsp;</td><td><font size=-1><em>Creation time.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
45 <tr><td nowrap align=right valign=top>time_t&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m4">topicset</a></td></tr>
46 <tr><td>&nbsp;</td><td><font size=-1><em>Time topic was set.</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
47 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m5">setby</a> [NICKMAX]</td></tr>
48 <tr><td>&nbsp;</td><td><font size=-1><em>The last user to set the topic.</em> <a href="#m5"></a><em></em></font><br><br></td></tr>
49 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m6">limit</a></td></tr>
50 <tr><td>&nbsp;</td><td><font size=-1><em>Contains the channel user limit.</em> <a href="#m6"></a><em></em></font><br><br></td></tr>
51 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m7">key</a> [32]</td></tr>
52 <tr><td>&nbsp;</td><td><font size=-1><em>Contains the channel key.</em> <a href="#m7"></a><em></em></font><br><br></td></tr>
53 <tr><td nowrap align=right valign=top>short int&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m8">topiclock</a></td></tr>
54 <tr><td>&nbsp;</td><td><font size=-1><em>Nonzero if the mode +t is set.</em> <a href="#m8"></a><em></em></font><br><br></td></tr>
55 <tr><td nowrap align=right valign=top>short int&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m9">noexternal</a></td></tr>
56 <tr><td>&nbsp;</td><td><font size=-1><em>Nonzero if the mode +n is set.</em> <a href="#m9"></a><em></em></font><br><br></td></tr>
57 <tr><td nowrap align=right valign=top>short int&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m10">inviteonly</a></td></tr>
58 <tr><td>&nbsp;</td><td><font size=-1><em>Nonzero if the mode +i is set.</em> <a href="#m10"></a><em></em></font><br><br></td></tr>
59 <tr><td nowrap align=right valign=top>short int&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m11">moderated</a></td></tr>
60 <tr><td>&nbsp;</td><td><font size=-1><em>Nonzero if the mode +m is set.</em> <a href="#m11"></a><em></em></font><br><br></td></tr>
61 <tr><td nowrap align=right valign=top>short int&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m12">secret</a></td></tr>
62 <tr><td>&nbsp;</td><td><font size=-1><em>Nonzero if the mode +s is set.</em> <a href="#m12"></a><em></em></font><br><br></td></tr>
63 <tr><td nowrap align=right valign=top>short int&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m13">c_private</a></td></tr>
64 <tr><td>&nbsp;</td><td><font size=-1><em>Nonzero if the mode +p is set.</em> <a href="#m13"></a><em></em></font><br><br></td></tr>
65 <tr><td nowrap align=right valign=top><a class="el" href="channels_8h.html#a5">BanList</a>&nbsp;</td><td valign=bottom><a class="el" href="classchanrec.html#m14">bans</a></td></tr>
66 <tr><td>&nbsp;</td><td><font size=-1><em>The list of all bans set on the channel.</em> <a href="#m14"></a><em></em></font><br><br></td></tr>
67 </table>
68 <hr><a name="_details"></a><h2>Detailed Description</h2>
69 Holds all relevent information for a channel.
70 <p>
71 This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type. 
72 <p>
73
74 <p>
75 Definition at line <a class="el" href="channels_8h-source.html#l00083">83</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
76 <a name="a4" doxytag="chanrec::chanrec"></a><p>
77 <table width="100%" cellpadding="2" cellspacing="0" border="0">
78   <tr>
79     <td class="md">
80       <table cellpadding="0" cellspacing="0" border="0">
81         <tr>
82           <td class="md" nowrap valign="top"> chanrec::chanrec </td>
83           <td class="md" valign="top">(&nbsp;</td>
84           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
85           <td class="md" valign="top">)&nbsp;</td>
86           <td class="md" nowrap></td>
87         </tr>
88
89       </table>
90     </td>
91   </tr>
92 </table>
93 <table cellspacing=5 cellpadding=0 border=0>
94   <tr>
95     <td>
96       &nbsp;
97     </td>
98     <td>
99
100 <p>
101 Creates a channel record and initialises it with default values.
102 <p>
103
104 <p>
105 Definition at line <a class="el" href="channels_8cpp-source.html#l00012">12</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
106 <p>
107 References <a class="el" href="channels_8h-source.html#l00144">c_private</a>, <a class="el" href="channels_8h-source.html#l00100">created</a>, <a class="el" href="channels_8h-source.html#l00130">inviteonly</a>, <a class="el" href="channels_8h-source.html#l00113">limit</a>, <a class="el" href="channels_8h-source.html#l00134">moderated</a>, <a class="el" href="channels_8h-source.html#l00126">noexternal</a>, <a class="el" href="channels_8h-source.html#l00139">secret</a>, <a class="el" href="channels_8h-source.html#l00122">topiclock</a>, and <a class="el" href="channels_8h-source.html#l00104">topicset</a>.
108 <p>
109 <div class="fragment"><pre>00013 {
110 00014         strcpy(name,<span class="stringliteral">""</span>);
111 00015         strcpy(custom_modes,<span class="stringliteral">""</span>);
112 00016         strcpy(topic,<span class="stringliteral">""</span>);
113 00017         strcpy(setby,<span class="stringliteral">""</span>);
114 00018         strcpy(key,<span class="stringliteral">""</span>);
115 00019         <a class="code" href="classchanrec.html#m3">created</a> = <a class="code" href="classchanrec.html#m4">topicset</a> = <a class="code" href="classchanrec.html#m6">limit</a> = 0;
116 00020         <a class="code" href="classchanrec.html#m8">topiclock</a> = <a class="code" href="classchanrec.html#m9">noexternal</a> = <a class="code" href="classchanrec.html#m10">inviteonly</a> = <a class="code" href="classchanrec.html#m11">moderated</a> = <a class="code" href="classchanrec.html#m12">secret</a> = <a class="code" href="classchanrec.html#m13">c_private</a> = <span class="keyword">false</span>;
117 00021 }
118 </pre></div>    </td>
119   </tr>
120 </table>
121 <a name="a5" doxytag="chanrec::~chanrec"></a><p>
122 <table width="100%" cellpadding="2" cellspacing="0" border="0">
123   <tr>
124     <td class="md">
125       <table cellpadding="0" cellspacing="0" border="0">
126         <tr>
127           <td class="md" nowrap valign="top"> virtual chanrec::~chanrec </td>
128           <td class="md" valign="top">(&nbsp;</td>
129           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
130           <td class="md" valign="top">)&nbsp;</td>
131           <td class="md" nowrap><code> [inline, virtual]</code></td>
132         </tr>
133
134       </table>
135     </td>
136   </tr>
137 </table>
138 <table cellspacing=5 cellpadding=0 border=0>
139   <tr>
140     <td>
141       &nbsp;
142     </td>
143     <td>
144
145 <p>
146
147 <p>
148 Definition at line <a class="el" href="channels_8h-source.html#l00174">174</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
149 <p>
150 <div class="fragment"><pre>00174 { <span class="comment">/* stub */</span> }
151 </pre></div>    </td>
152   </tr>
153 </table>
154 <hr><h2>Member Function Documentation</h2>
155 <a name="a3" doxytag="chanrec::GetModeParameter"></a><p>
156 <table width="100%" cellpadding="2" cellspacing="0" border="0">
157   <tr>
158     <td class="md">
159       <table cellpadding="0" cellspacing="0" border="0">
160         <tr>
161           <td class="md" nowrap valign="top"> std::string chanrec::GetModeParameter </td>
162           <td class="md" valign="top">(&nbsp;</td>
163           <td class="md" nowrap valign="top">char&nbsp;</td>
164           <td class="mdname1" valign="top" nowrap>&nbsp; <em>mode</em>          </td>
165           <td class="md" valign="top">)&nbsp;</td>
166           <td class="md" nowrap></td>
167         </tr>
168
169       </table>
170     </td>
171   </tr>
172 </table>
173 <table cellspacing=5 cellpadding=0 border=0>
174   <tr>
175     <td>
176       &nbsp;
177     </td>
178     <td>
179
180 <p>
181 Returns the parameter for a custom mode on a channel.
182 <p>
183 For example if "+L #foo" is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.
184 <p>
185 Definition at line <a class="el" href="channels_8cpp-source.html#l00087">87</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
186 <p>
187 References <a class="el" href="channels_8cpp-source.html#l00010">custom_mode_params</a>.
188 <p>
189 <div class="fragment"><pre>00088 {
190 00089         <span class="keywordflow">if</span> (<a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.size())
191 00090         {
192 00091                 <span class="keywordflow">for</span> (vector&lt;ModeParameter&gt;::iterator i = <a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.begin(); i &lt; <a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.end(); i++)
193 00092                 {
194 00093                         <span class="keywordflow">if</span> ((i-&gt;mode == mode) &amp;&amp; (!strcasecmp(this-&gt;name,i-&gt;channel)))
195 00094                         {
196 00095                                 <span class="keywordflow">return</span> std::string(i-&gt;parameter);
197 00096                         }
198 00097                 }
199 00098         }
200 00099         <span class="keywordflow">return</span> std::string(<span class="stringliteral">""</span>);
201 00100 }
202 </pre></div>    </td>
203   </tr>
204 </table>
205 <a name="a2" doxytag="chanrec::IsCustomModeSet"></a><p>
206 <table width="100%" cellpadding="2" cellspacing="0" border="0">
207   <tr>
208     <td class="md">
209       <table cellpadding="0" cellspacing="0" border="0">
210         <tr>
211           <td class="md" nowrap valign="top"> bool chanrec::IsCustomModeSet </td>
212           <td class="md" valign="top">(&nbsp;</td>
213           <td class="md" nowrap valign="top">char&nbsp;</td>
214           <td class="mdname1" valign="top" nowrap>&nbsp; <em>mode</em>          </td>
215           <td class="md" valign="top">)&nbsp;</td>
216           <td class="md" nowrap></td>
217         </tr>
218
219       </table>
220     </td>
221   </tr>
222 </table>
223 <table cellspacing=5 cellpadding=0 border=0>
224   <tr>
225     <td>
226       &nbsp;
227     </td>
228     <td>
229
230 <p>
231 Returns true if a custom mode is set on a channel.
232 <p>
233
234 <p>
235 Definition at line <a class="el" href="channels_8cpp-source.html#l00081">81</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
236 <p>
237 <div class="fragment"><pre>00082 {
238 00083         log(DEBUG,<span class="stringliteral">"Checking ISCustomModeSet: %c %s"</span>,mode,this-&gt;custom_modes);
239 00084         <span class="keywordflow">return</span> (strchr(this-&gt;custom_modes,mode) != 0);
240 00085 }
241 </pre></div>    </td>
242   </tr>
243 </table>
244 <a name="a0" doxytag="chanrec::SetCustomMode"></a><p>
245 <table width="100%" cellpadding="2" cellspacing="0" border="0">
246   <tr>
247     <td class="md">
248       <table cellpadding="0" cellspacing="0" border="0">
249         <tr>
250           <td class="md" nowrap valign="top"> void chanrec::SetCustomMode </td>
251           <td class="md" valign="top">(&nbsp;</td>
252           <td class="md" nowrap valign="top">char&nbsp;</td>
253           <td class="mdname" nowrap>&nbsp; <em>mode</em>, </td>
254         </tr>
255         <tr>
256           <td></td>
257           <td></td>
258           <td class="md" nowrap>bool&nbsp;</td>
259           <td class="mdname" nowrap>&nbsp; <em>mode_on</em></td>
260         </tr>
261         <tr>
262           <td></td>
263           <td class="md">)&nbsp;</td>
264           <td class="md" colspan="2"></td>
265         </tr>
266
267       </table>
268     </td>
269   </tr>
270 </table>
271 <table cellspacing=5 cellpadding=0 border=0>
272   <tr>
273     <td>
274       &nbsp;
275     </td>
276     <td>
277
278 <p>
279 Sets or unsets a custom mode in the channels info.
280 <p>
281
282 <p>
283 Definition at line <a class="el" href="channels_8cpp-source.html#l00023">23</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
284 <p>
285 References <a class="el" href="channels_8h-source.html#l00092">custom_modes</a>, and <a class="el" href="channels_8cpp-source.html#l00050">SetCustomModeParam()</a>.
286 <p>
287 <div class="fragment"><pre>00024 {
288 00025         <span class="keywordflow">if</span> (mode_on) {
289 00026                 <span class="keywordtype">char</span> m[3];
290 00027                 m[0] = mode;
291 00028                 m[1] = <span class="charliteral">'\0'</span>;
292 00029                 <span class="keywordflow">if</span> (!strchr(this-&gt;custom_modes,mode))
293 00030                 {
294 00031                         strncat(custom_modes,m,MAXMODES);
295 00032                 }
296 00033                 log(DEBUG,<span class="stringliteral">"Custom mode %c set"</span>,mode);
297 00034         }
298 00035         <span class="keywordflow">else</span> {
299 00036                 <span class="keywordtype">char</span> temp[MAXBUF];
300 00037                 <span class="keywordtype">int</span> count = 0;
301 00038                 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> q = 0; q &lt; strlen(custom_modes); q++) {
302 00039                         <span class="keywordflow">if</span> (<a class="code" href="classchanrec.html#m1">custom_modes</a>[q] != mode) {
303 00040                                 temp[count++] = mode;
304 00041                         }
305 00042                 }
306 00043                 temp[count] = <span class="charliteral">'\0'</span>;
307 00044                 strncpy(custom_modes,temp,MAXMODES);
308 00045                 log(DEBUG,<span class="stringliteral">"Custom mode %c removed"</span>,mode);
309 00046                 this-&gt;<a class="code" href="classchanrec.html#a1">SetCustomModeParam</a>(mode,<span class="stringliteral">""</span>,<span class="keyword">false</span>);
310 00047         }
311 00048 }
312 </pre></div>    </td>
313   </tr>
314 </table>
315 <a name="a1" doxytag="chanrec::SetCustomModeParam"></a><p>
316 <table width="100%" cellpadding="2" cellspacing="0" border="0">
317   <tr>
318     <td class="md">
319       <table cellpadding="0" cellspacing="0" border="0">
320         <tr>
321           <td class="md" nowrap valign="top"> void chanrec::SetCustomModeParam </td>
322           <td class="md" valign="top">(&nbsp;</td>
323           <td class="md" nowrap valign="top">char&nbsp;</td>
324           <td class="mdname" nowrap>&nbsp; <em>mode</em>, </td>
325         </tr>
326         <tr>
327           <td></td>
328           <td></td>
329           <td class="md" nowrap>char *&nbsp;</td>
330           <td class="mdname" nowrap>&nbsp; <em>parameter</em>, </td>
331         </tr>
332         <tr>
333           <td></td>
334           <td></td>
335           <td class="md" nowrap>bool&nbsp;</td>
336           <td class="mdname" nowrap>&nbsp; <em>mode_on</em></td>
337         </tr>
338         <tr>
339           <td></td>
340           <td class="md">)&nbsp;</td>
341           <td class="md" colspan="2"></td>
342         </tr>
343
344       </table>
345     </td>
346   </tr>
347 </table>
348 <table cellspacing=5 cellpadding=0 border=0>
349   <tr>
350     <td>
351       &nbsp;
352     </td>
353     <td>
354
355 <p>
356 Sets or unsets the parameters for a custom mode in a channels info.
357 <p>
358
359 <p>
360 Definition at line <a class="el" href="channels_8cpp-source.html#l00050">50</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
361 <p>
362 References <a class="el" href="channels_8h-source.html#l00064">ModeParameter::channel</a>, <a class="el" href="channels_8cpp-source.html#l00010">custom_mode_params</a>, <a class="el" href="channels_8h-source.html#l00062">ModeParameter::mode</a>, and <a class="el" href="channels_8h-source.html#l00063">ModeParameter::parameter</a>.
363 <p>
364 Referenced by <a class="el" href="channels_8cpp-source.html#l00023">SetCustomMode()</a>.
365 <p>
366 <div class="fragment"><pre>00051 {
367 00052 
368 00053         log(DEBUG,<span class="stringliteral">"SetCustomModeParam called"</span>);
369 00054         <a class="code" href="classModeParameter.html">ModeParameter</a> M;
370 00055         M.<a class="code" href="classModeParameter.html#m0">mode</a> = mode;
371 00056         strcpy(M.<a class="code" href="classModeParameter.html#m2">channel</a>,this-&gt;name);
372 00057         strcpy(M.<a class="code" href="classModeParameter.html#m1">parameter</a>,parameter);
373 00058         <span class="keywordflow">if</span> (mode_on)
374 00059         {
375 00060                 log(DEBUG,<span class="stringliteral">"Custom mode parameter %c %s added"</span>,mode,parameter);
376 00061                 <a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.push_back(M);
377 00062         }
378 00063         <span class="keywordflow">else</span>
379 00064         {
380 00065                 <span class="keywordflow">if</span> (<a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.size())
381 00066                 {
382 00067                         <span class="keywordflow">for</span> (vector&lt;ModeParameter&gt;::iterator i = <a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.begin(); i &lt; <a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.end(); i++)
383 00068                         {
384 00069                                 <span class="keywordflow">if</span> ((i-&gt;mode == mode) &amp;&amp; (!strcasecmp(this-&gt;name,i-&gt;channel)))
385 00070                                 {
386 00071                                         log(DEBUG,<span class="stringliteral">"Custom mode parameter %c %s removed"</span>,mode,parameter);
387 00072                                         <a class="code" href="channels_8cpp.html#a0">custom_mode_params</a>.erase(i);
388 00073                                         <span class="keywordflow">return</span>;
389 00074                                 }
390 00075                         }
391 00076                 }
392 00077                 log(DEBUG,<span class="stringliteral">"*** BUG *** Attempt to remove non-existent mode parameter!"</span>);
393 00078         }
394 00079 }
395 </pre></div>    </td>
396   </tr>
397 </table>
398 <hr><h2>Member Data Documentation</h2>
399 <a name="m14" doxytag="chanrec::bans"></a><p>
400 <table width="100%" cellpadding="2" cellspacing="0" border="0">
401   <tr>
402     <td class="md">
403       <table cellpadding="0" cellspacing="0" border="0">
404         <tr>
405           <td class="md" nowrap valign="top"> <a class="el" href="channels_8h.html#a5">BanList</a> chanrec::bans
406       </table>
407     </td>
408   </tr>
409 </table>
410 <table cellspacing=5 cellpadding=0 border=0>
411   <tr>
412     <td>
413       &nbsp;
414     </td>
415     <td>
416
417 <p>
418 The list of all bans set on the channel.
419 <p>
420
421 <p>
422 Definition at line <a class="el" href="channels_8h-source.html#l00148">148</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
423   </tr>
424 </table>
425 <a name="m13" doxytag="chanrec::c_private"></a><p>
426 <table width="100%" cellpadding="2" cellspacing="0" border="0">
427   <tr>
428     <td class="md">
429       <table cellpadding="0" cellspacing="0" border="0">
430         <tr>
431           <td class="md" nowrap valign="top"> short int chanrec::c_private
432       </table>
433     </td>
434   </tr>
435 </table>
436 <table cellspacing=5 cellpadding=0 border=0>
437   <tr>
438     <td>
439       &nbsp;
440     </td>
441     <td>
442
443 <p>
444 Nonzero if the mode +p is set.
445 <p>
446 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m12">chanrec::secret</a>
447 <p>
448 Definition at line <a class="el" href="channels_8h-source.html#l00144">144</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
449 <p>
450 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
451   </tr>
452 </table>
453 <a name="m3" doxytag="chanrec::created"></a><p>
454 <table width="100%" cellpadding="2" cellspacing="0" border="0">
455   <tr>
456     <td class="md">
457       <table cellpadding="0" cellspacing="0" border="0">
458         <tr>
459           <td class="md" nowrap valign="top"> time_t chanrec::created
460       </table>
461     </td>
462   </tr>
463 </table>
464 <table cellspacing=5 cellpadding=0 border=0>
465   <tr>
466     <td>
467       &nbsp;
468     </td>
469     <td>
470
471 <p>
472 Creation time.
473 <p>
474
475 <p>
476 Definition at line <a class="el" href="channels_8h-source.html#l00100">100</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
477 <p>
478 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
479   </tr>
480 </table>
481 <a name="m1" doxytag="chanrec::custom_modes"></a><p>
482 <table width="100%" cellpadding="2" cellspacing="0" border="0">
483   <tr>
484     <td class="md">
485       <table cellpadding="0" cellspacing="0" border="0">
486         <tr>
487           <td class="md" nowrap valign="top"> char chanrec::custom_modes[MAXMODES]
488       </table>
489     </td>
490   </tr>
491 </table>
492 <table cellspacing=5 cellpadding=0 border=0>
493   <tr>
494     <td>
495       &nbsp;
496     </td>
497     <td>
498
499 <p>
500 Custom modes for the channel.
501 <p>
502 Plugins may use this field in any way they see fit.
503 <p>
504 Definition at line <a class="el" href="channels_8h-source.html#l00092">92</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
505 <p>
506 Referenced by <a class="el" href="channels_8cpp-source.html#l00023">SetCustomMode()</a>.    </td>
507   </tr>
508 </table>
509 <a name="m10" doxytag="chanrec::inviteonly"></a><p>
510 <table width="100%" cellpadding="2" cellspacing="0" border="0">
511   <tr>
512     <td class="md">
513       <table cellpadding="0" cellspacing="0" border="0">
514         <tr>
515           <td class="md" nowrap valign="top"> short int chanrec::inviteonly
516       </table>
517     </td>
518   </tr>
519 </table>
520 <table cellspacing=5 cellpadding=0 border=0>
521   <tr>
522     <td>
523       &nbsp;
524     </td>
525     <td>
526
527 <p>
528 Nonzero if the mode +i is set.
529 <p>
530
531 <p>
532 Definition at line <a class="el" href="channels_8h-source.html#l00130">130</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
533 <p>
534 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
535   </tr>
536 </table>
537 <a name="m7" doxytag="chanrec::key"></a><p>
538 <table width="100%" cellpadding="2" cellspacing="0" border="0">
539   <tr>
540     <td class="md">
541       <table cellpadding="0" cellspacing="0" border="0">
542         <tr>
543           <td class="md" nowrap valign="top"> char chanrec::key[32]
544       </table>
545     </td>
546   </tr>
547 </table>
548 <table cellspacing=5 cellpadding=0 border=0>
549   <tr>
550     <td>
551       &nbsp;
552     </td>
553     <td>
554
555 <p>
556 Contains the channel key.
557 <p>
558 If this value is an empty string, there is no channel key in place.
559 <p>
560 Definition at line <a class="el" href="channels_8h-source.html#l00118">118</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
561   </tr>
562 </table>
563 <a name="m6" doxytag="chanrec::limit"></a><p>
564 <table width="100%" cellpadding="2" cellspacing="0" border="0">
565   <tr>
566     <td class="md">
567       <table cellpadding="0" cellspacing="0" border="0">
568         <tr>
569           <td class="md" nowrap valign="top"> long chanrec::limit
570       </table>
571     </td>
572   </tr>
573 </table>
574 <table cellspacing=5 cellpadding=0 border=0>
575   <tr>
576     <td>
577       &nbsp;
578     </td>
579     <td>
580
581 <p>
582 Contains the channel user limit.
583 <p>
584 If this value is zero, there is no limit in place.
585 <p>
586 Definition at line <a class="el" href="channels_8h-source.html#l00113">113</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
587 <p>
588 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
589   </tr>
590 </table>
591 <a name="m11" doxytag="chanrec::moderated"></a><p>
592 <table width="100%" cellpadding="2" cellspacing="0" border="0">
593   <tr>
594     <td class="md">
595       <table cellpadding="0" cellspacing="0" border="0">
596         <tr>
597           <td class="md" nowrap valign="top"> short int chanrec::moderated
598       </table>
599     </td>
600   </tr>
601 </table>
602 <table cellspacing=5 cellpadding=0 border=0>
603   <tr>
604     <td>
605       &nbsp;
606     </td>
607     <td>
608
609 <p>
610 Nonzero if the mode +m is set.
611 <p>
612
613 <p>
614 Definition at line <a class="el" href="channels_8h-source.html#l00134">134</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
615 <p>
616 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
617   </tr>
618 </table>
619 <a name="m0" doxytag="chanrec::name"></a><p>
620 <table width="100%" cellpadding="2" cellspacing="0" border="0">
621   <tr>
622     <td class="md">
623       <table cellpadding="0" cellspacing="0" border="0">
624         <tr>
625           <td class="md" nowrap valign="top"> char chanrec::name[CHANMAX]
626       </table>
627     </td>
628   </tr>
629 </table>
630 <table cellspacing=5 cellpadding=0 border=0>
631   <tr>
632     <td>
633       &nbsp;
634     </td>
635     <td>
636
637 <p>
638 The channels name.
639 <p>
640
641 <p>
642 Definition at line <a class="el" href="channels_8h-source.html#l00088">88</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
643   </tr>
644 </table>
645 <a name="m9" doxytag="chanrec::noexternal"></a><p>
646 <table width="100%" cellpadding="2" cellspacing="0" border="0">
647   <tr>
648     <td class="md">
649       <table cellpadding="0" cellspacing="0" border="0">
650         <tr>
651           <td class="md" nowrap valign="top"> short int chanrec::noexternal
652       </table>
653     </td>
654   </tr>
655 </table>
656 <table cellspacing=5 cellpadding=0 border=0>
657   <tr>
658     <td>
659       &nbsp;
660     </td>
661     <td>
662
663 <p>
664 Nonzero if the mode +n is set.
665 <p>
666
667 <p>
668 Definition at line <a class="el" href="channels_8h-source.html#l00126">126</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
669 <p>
670 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
671   </tr>
672 </table>
673 <a name="m12" doxytag="chanrec::secret"></a><p>
674 <table width="100%" cellpadding="2" cellspacing="0" border="0">
675   <tr>
676     <td class="md">
677       <table cellpadding="0" cellspacing="0" border="0">
678         <tr>
679           <td class="md" nowrap valign="top"> short int chanrec::secret
680       </table>
681     </td>
682   </tr>
683 </table>
684 <table cellspacing=5 cellpadding=0 border=0>
685   <tr>
686     <td>
687       &nbsp;
688     </td>
689     <td>
690
691 <p>
692 Nonzero if the mode +s is set.
693 <p>
694 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m13">chanrec::c_private</a>
695 <p>
696 Definition at line <a class="el" href="channels_8h-source.html#l00139">139</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
697 <p>
698 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
699   </tr>
700 </table>
701 <a name="m5" doxytag="chanrec::setby"></a><p>
702 <table width="100%" cellpadding="2" cellspacing="0" border="0">
703   <tr>
704     <td class="md">
705       <table cellpadding="0" cellspacing="0" border="0">
706         <tr>
707           <td class="md" nowrap valign="top"> char chanrec::setby[NICKMAX]
708       </table>
709     </td>
710   </tr>
711 </table>
712 <table cellspacing=5 cellpadding=0 border=0>
713   <tr>
714     <td>
715       &nbsp;
716     </td>
717     <td>
718
719 <p>
720 The last user to set the topic.
721 <p>
722 If this member is an empty string, no topic was ever set.
723 <p>
724 Definition at line <a class="el" href="channels_8h-source.html#l00108">108</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
725   </tr>
726 </table>
727 <a name="m2" doxytag="chanrec::topic"></a><p>
728 <table width="100%" cellpadding="2" cellspacing="0" border="0">
729   <tr>
730     <td class="md">
731       <table cellpadding="0" cellspacing="0" border="0">
732         <tr>
733           <td class="md" nowrap valign="top"> char chanrec::topic[MAXBUF]
734       </table>
735     </td>
736   </tr>
737 </table>
738 <table cellspacing=5 cellpadding=0 border=0>
739   <tr>
740     <td>
741       &nbsp;
742     </td>
743     <td>
744
745 <p>
746 Channel topic.
747 <p>
748 If this is an empty string, no channel topic is set.
749 <p>
750 Definition at line <a class="el" href="channels_8h-source.html#l00097">97</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
751   </tr>
752 </table>
753 <a name="m8" doxytag="chanrec::topiclock"></a><p>
754 <table width="100%" cellpadding="2" cellspacing="0" border="0">
755   <tr>
756     <td class="md">
757       <table cellpadding="0" cellspacing="0" border="0">
758         <tr>
759           <td class="md" nowrap valign="top"> short int chanrec::topiclock
760       </table>
761     </td>
762   </tr>
763 </table>
764 <table cellspacing=5 cellpadding=0 border=0>
765   <tr>
766     <td>
767       &nbsp;
768     </td>
769     <td>
770
771 <p>
772 Nonzero if the mode +t is set.
773 <p>
774
775 <p>
776 Definition at line <a class="el" href="channels_8h-source.html#l00122">122</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
777 <p>
778 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
779   </tr>
780 </table>
781 <a name="m4" doxytag="chanrec::topicset"></a><p>
782 <table width="100%" cellpadding="2" cellspacing="0" border="0">
783   <tr>
784     <td class="md">
785       <table cellpadding="0" cellspacing="0" border="0">
786         <tr>
787           <td class="md" nowrap valign="top"> time_t chanrec::topicset
788       </table>
789     </td>
790   </tr>
791 </table>
792 <table cellspacing=5 cellpadding=0 border=0>
793   <tr>
794     <td>
795       &nbsp;
796     </td>
797     <td>
798
799 <p>
800 Time topic was set.
801 <p>
802 If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#m3">chanrec::created</a>
803 <p>
804 Definition at line <a class="el" href="channels_8h-source.html#l00104">104</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
805 <p>
806 Referenced by <a class="el" href="channels_8cpp-source.html#l00012">chanrec()</a>.    </td>
807   </tr>
808 </table>
809 <hr>The documentation for this class was generated from the following files:<ul>
810 <li><a class="el" href="channels_8h-source.html">channels.h</a><li><a class="el" href="channels_8cpp-source.html">channels.cpp</a></ul>
811 <hr><address style="align: right;"><small>Generated on Sun Apr 25 00:24:16 2004 for InspIRCd by
812 <a href="http://www.doxygen.org/index.html">
813 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
814 width=110 height=53></a>1.3-rc3 </small></address>
815 </body>
816 </html>