diff options
Diffstat (limited to 'docs/module-doc/classExtensible.html')
| -rw-r--r-- | docs/module-doc/classExtensible.html | 29 |
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index 8e3371ba5..393ef362b 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -86,7 +86,15 @@ Definition at line <a class="el" href="base_8h-source.html#l00050">50</a> of fil <p> Extend an Extensible class. <p> -You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, <a class="el" href="classExtensible.html#a0">Extensible::Extend</a> will return false in this case. On successful extension, Extend returns true. </td> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data </td></tr> + <tr><td valign=top><em>p</em> </td><td>This parameter is a pointer to any data you wish to associate with the object</td></tr> + </table> +</dl> +You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, <a class="el" href="classExtensible.html#a0">Extensible::Extend</a> will return false in this case.<p> +<dl compact><dt><b>Returns:</b></dt><dd>Returns true on success, false if otherwise</dd></dl> + </td> </tr> </table> <a name="a2" doxytag="Extensible::GetExt"></a><p> @@ -117,7 +125,13 @@ You must provide a key to store the data as, and a void* to the data (typedef Vo <p> Get an extension item. <p> -You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned. </td> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.</dd></dl> + </td> </tr> </table> <a name="a1" doxytag="Extensible::Shrink"></a><p> @@ -148,7 +162,14 @@ You must provide a key name, which is case sensitive. If you provide a non-exist <p> Shrink an Extensible class. <p> -You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns true on success. </td> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr> + </table> +</dl> +You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false.<p> +<dl compact><dt><b>Returns:</b></dt><dd>Returns true on success.</dd></dl> + </td> </tr> </table> <hr><h2>Member Data Documentation</h2> @@ -180,7 +201,7 @@ Definition at line <a class="el" href="base_8h-source.html#l00054">54</a> of fil </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="base_8h-source.html">base.h</a></ul> -<hr size="1"><address style="align: right;"><small>Generated on Tue May 24 02:31:59 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Wed May 25 21:43:11 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.3 </small></address> |