docs/module-doc/classModeParameter.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>InspIRCd: ModeParameter class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>ModeParameter Class Reference</h1>Holds a custom parameter to a module-defined channel mode e.g.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="channels_8h-source.html">channels.h</a>&gt;</code>
  12 <p>
  13 Inherits <a class="el" href="classclassbase.html">classbase</a>.
  14 <p>
  15 <a href="classModeParameter-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  16 <tr><td></td></tr>
  17 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html#o0">mode</a></td></tr>
  19
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html#o1">parameter</a> [MAXBUF]</td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html#o2">channel</a> [CHANMAX]</td></tr>
  23
  24 </table>
  25 <hr><a name="_details"></a><h2>Detailed Description</h2>
  26 Holds a custom parameter to a module-defined channel mode e.g.
  27 <p>
  28 for +L this would hold the channel name.
  29 <p>
  30
  31 <p>
  32 Definition at line <a class="el" href="channels_8h-source.html#l00070">70</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Member Data Documentation</h2>
  33 <a name="o2" doxytag="ModeParameter::channel"></a><p>
  34 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  35   <tr>
  36     <td class="mdRow">
  37       <table cellpadding="0" cellspacing="0" border="0">
  38         <tr>
  39           <td class="md" nowrap valign="top"> char <a class="el" href="classModeParameter.html#o2">ModeParameter::channel</a>[CHANMAX]
  40       </table>
  41     </td>
  42   </tr>
  43 </table>
  44 <table cellspacing=5 cellpadding=0 border=0>
  45   <tr>
  46     <td>
  47       &nbsp;
  48     </td>
  49     <td>
  50
  51 <p>
  52
  53 <p>
  54 Definition at line <a class="el" href="channels_8h-source.html#l00075">75</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
  55 <p>
  56 Referenced by <a class="el" href="channels_8cpp-source.html#l00149">chanrec::SetCustomModeParam()</a>.    </td>
  57   </tr>
  58 </table>
  59 <a name="o0" doxytag="ModeParameter::mode"></a><p>
  60 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  61   <tr>
  62     <td class="mdRow">
  63       <table cellpadding="0" cellspacing="0" border="0">
  64         <tr>
  65           <td class="md" nowrap valign="top"> char <a class="el" href="classModeParameter.html#o0">ModeParameter::mode</a>
  66       </table>
  67     </td>
  68   </tr>
  69 </table>
  70 <table cellspacing=5 cellpadding=0 border=0>
  71   <tr>
  72     <td>
  73       &nbsp;
  74     </td>
  75     <td>
  76
  77 <p>
  78
  79 <p>
  80 Definition at line <a class="el" href="channels_8h-source.html#l00073">73</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
  81 <p>
  82 Referenced by <a class="el" href="channels_8cpp-source.html#l00149">chanrec::SetCustomModeParam()</a>.    </td>
  83   </tr>
  84 </table>
  85 <a name="o1" doxytag="ModeParameter::parameter"></a><p>
  86 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  87   <tr>
  88     <td class="mdRow">
  89       <table cellpadding="0" cellspacing="0" border="0">
  90         <tr>
  91           <td class="md" nowrap valign="top"> char <a class="el" href="classModeParameter.html#o1">ModeParameter::parameter</a>[MAXBUF]
  92       </table>
  93     </td>
  94   </tr>
  95 </table>
  96 <table cellspacing=5 cellpadding=0 border=0>
  97   <tr>
  98     <td>
  99       &nbsp;
 100     </td>
 101     <td>
 102
 103 <p>
 104
 105 <p>
 106 Definition at line <a class="el" href="channels_8h-source.html#l00074">74</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 107 <p>
 108 Referenced by <a class="el" href="channels_8cpp-source.html#l00149">chanrec::SetCustomModeParam()</a>.    </td>
 109   </tr>
 110 </table>
 111 <hr>The documentation for this class was generated from the following file:<ul>
 112 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
 113 <hr size="1"><address style="align: right;"><small>Generated on Sat Apr 9 14:38:29 2005 for InspIRCd by
 114 <a href="http://www.doxygen.org/index.html">
 115 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 116 </a>1.3.3 </small></address>
 117 </body>
 118 </html>