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