- multi_platform_plugin_spl_demo.zip
- builds
- dotnet2003
- linux
- vc6
- libspl.dsp
- libspl.dsw
- code
- documents
- examples
- bin
- ConsoleTest.exe
- MfcPluginDllTest.exe
- MFCPluginTest.exe
- MfcThreadPluginTest.exe
- spl.dll
- StartConsoleTest.bat
- builds
- ConsoleTest
- examples.sln
- MfcPluginDllTest
- MfcPluginTest
- MfcThreadPluginTest
- plArgInfos
- plHelloWorld
- plHelloWorldNoMacros
- plReverse
- plReverseSlow
- plToLower
- plToUpper
- obj
- plugins
- plArgInfos.dll
- plHelloWorld.dll
- plHelloWorldNoMacros.dll
- plReverse.dll
- plReverseSlow.dll
- plToLower.dll
- plToUpper.dll
- history.txt
- lib
- dll
- spl.dll
- spl.lib
- spld.dll
- spld.lib
- libspl.lib
- libspld.lib
- license.txt
- obj
- readme.txt
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>SPL Library: SPL::slcPluginArgs class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>SPL::slcPluginArgs Class Reference</h1>The plugin argument class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="spl__pluginargs_8h-source.html">spl_pluginargs.h</a>></code>
<p>
Inheritance diagram for SPL::slcPluginArgs:<p><center><img src="classSPL_1_1slcPluginArgs__inherit__graph.png" border="0" usemap="#SPL_1_1slcPluginArgs__inherit__map" alt="Inheritance graph"></center>
<map name="SPL_1_1slcPluginArgs__inherit__map">
<area href="classSPL_1_1slcMutex.html" shape="rect" coords="20,17,113,161" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for SPL::slcPluginArgs:<p><center><img src="classSPL_1_1slcPluginArgs__coll__graph.png" border="0" usemap="#SPL_1_1slcPluginArgs__coll__map" alt="Collaboration graph"></center>
<map name="SPL_1_1slcPluginArgs__coll__map">
<area href="classSPL_1_1slcMutex.html" shape="rect" coords="20,17,113,161" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classSPL_1_1slcPluginArgs-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a0">slcPluginArgs</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a1">slcPluginArgs</a> (const <a class="el" href="classSPL_1_1slcPluginArgs.html">slcPluginArgs</a> &a_pluginArgs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a2">~slcPluginArgs</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#a2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a3">SetArg</a> (long a_lIndex, void *a_pvArg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an argument at the specified index (0-based). <a href="#a3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a4">SetArg</a> (void *a_pvArg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an argument at the next free position. <a href="#a4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a5">GetCount</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of arguments. <a href="#a5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a6">GetArg</a> (long a_lIndex, void *a_pvArg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the argument at the specified index. <a href="#a6"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long SPL_API </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#a7">Clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of deleted arguments. <a href="#a7"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>map< long, SPL_BITTYPE > </td><td class="memItemRight" valign=bottom><a class="el" href="classSPL_1_1slcPluginArgs.html#r0">m_mapArgs</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Map for arguments. <a href="#r0"></a><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The plugin argument class.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="SPL::slcPluginArgs::slcPluginArgs" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> slcPluginArgs::slcPluginArgs </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Default constructor.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="SPL::slcPluginArgs::slcPluginArgs" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> slcPluginArgs::slcPluginArgs </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classSPL_1_1slcPluginArgs.html">slcPluginArgs</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>a_pluginArgs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Copy constructor.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="SPL::slcPluginArgs::~slcPluginArgs" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> slcPluginArgs::~<a class="el" href="classSPL_1_1slcPluginArgs.html">slcPluginArgs</a> </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Default destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a7" doxytag="SPL::slcPluginArgs::Clear" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long slcPluginArgs::Clear </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the number of deleted arguments.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Number of arguments. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="SPL::slcPluginArgs::GetArg" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long slcPluginArgs::GetArg </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">long </td>
<td class="mdname" nowrap> <em>a_lIndex</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>a_pvArg</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the argument at the specified index.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>a_lIndex</em> </td><td>[in] Index of argument to get. </td></tr>
<tr><td valign=top><em>a_pvArg</em> </td><td>[out] Pointer to a valid, allocated memory block holding the argument. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The argument's index (should not differ from a_lIndex!). </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="SPL::slcPluginArgs::GetCount" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long slcPluginArgs::GetCount </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the number of arguments.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Number of arguments. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="SPL::slcPluginArgs::SetArg" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long slcPluginArgs::SetArg </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname1" valign="top" nowrap> <em>a_pvArg</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets an argument at the next free position.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>a_pvArg</em> </td><td>[in] Pointer to an argument. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The argument's index. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="SPL::slcPluginArgs::SetArg" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long slcPluginArgs::SetArg </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">long </td>
<td class="mdname" nowrap> <em>a_lIndex</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>a_pvArg</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets an argument at the specified index (0-based).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>a_lIndex</em> </td><td>[in] Index where to fill the argument in. </td></tr>
<tr><td valign=top><em>a_pvArg</em> </td><td>[in] Pointer to an argument. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The argument's index (should not differ from a_lIndex!). </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="r0" doxytag="SPL::slcPluginArgs::m_mapArgs" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> map< long, SPL_BITTYPE > <a class="el" href="classSPL_1_1slcPluginArgs.html#r0">SPL::slcPluginArgs::m_mapArgs</a><code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Map for arguments.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="spl__pluginargs_8h-source.html">spl_pluginargs.h</a><li><a class="el" href="spl__pluginargs_8cpp.html">spl_pluginargs.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun May 9 15:01:05 2004 for SPL Library by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.6 </small></address>
</body>
</html>
|
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please
let us know and we'll add colourisation support for it.
This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.
A list of licenses authors might use can be found here
I was born in 1982 near Stuttgart / Germany and began my first steps in programming computers at the age of only nine years on an old Commodore CBM 7072. In 2002 I finished my education as IT specialist for software engineering and did my civillian service afterwards. Currently I'm working as leader of the software division in a bigger company located in south west Germany, mainly on software development and research projects for multimedia terminals and user recognition/verification systems.