336 lines
15 KiB
HTML
336 lines
15 KiB
HTML
<!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>XQilla Simple API Documentation</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.5.5 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>ExternalFunction Class Reference</h1><!-- doxytag: class="ExternalFunction" --><code>#include <<a class="el" href="ExternalFunction_8hpp-source.html">ExternalFunction.hpp</a>></code>
|
|
<p>
|
|
|
|
<p>
|
|
<a href="classExternalFunction-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#15c836af39ef9a5d79a3edbb87e22176">~ExternalFunction</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#68d2eb21c7bd8072fdfd01cd3c794fd9">getURI</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#8bf0aa847fbcc2defbe287e277223e58">getName</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#45708d6c78ab5cbbc8e39483defeea76">getURINameHash</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#6edce344cc26cbee3007846c922c2973">getNumberOfArguments</a> () const </td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classResult.html">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#1f092fc7e07b1ff4075143282813b064">execute</a> (const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> *args, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the (non-updating) function. <a href="#1f092fc7e07b1ff4075143282813b064"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PendingUpdateList </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#04d1c19baeb22db53c1453efbbbb4c31">executeUpdate</a> (const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> *args, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the updating function. <a href="#04d1c19baeb22db53c1453efbbbb4c31"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#f2a09a3de46e742706969e60bd4db056">ExternalFunction</a> (const XMLCh *uri, const XMLCh *name, unsigned int numberOfArgs, <a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *mm)</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#7707c9ebb2cbc37e915b849ffce4371f">uri_</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#9e666ea401b178e10ab3c0799b3270bd">name_</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#0ad0a21279823e2a038364827e859725">uriName_</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#c4803adcaf53f91a84e6a83c25571cf5">numArgs_</a></td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a></td></tr>
|
|
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="15c836af39ef9a5d79a3edbb87e22176"></a><!-- doxytag: member="ExternalFunction::~ExternalFunction" ref="15c836af39ef9a5d79a3edbb87e22176" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ExternalFunction::~ExternalFunction </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f2a09a3de46e742706969e60bd4db056"></a><!-- doxytag: member="ExternalFunction::ExternalFunction" ref="f2a09a3de46e742706969e60bd4db056" args="(const XMLCh *uri, const XMLCh *name, unsigned int numberOfArgs, XPath2MemoryManager *mm)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ExternalFunction::ExternalFunction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh * </td>
|
|
<td class="paramname"> <em>uri</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLCh * </td>
|
|
<td class="paramname"> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"> <em>numberOfArgs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> * </td>
|
|
<td class="paramname"> <em>mm</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"><code> [protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="68d2eb21c7bd8072fdfd01cd3c794fd9"></a><!-- doxytag: member="ExternalFunction::getURI" ref="68d2eb21c7bd8072fdfd01cd3c794fd9" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh* ExternalFunction::getURI </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8bf0aa847fbcc2defbe287e277223e58"></a><!-- doxytag: member="ExternalFunction::getName" ref="8bf0aa847fbcc2defbe287e277223e58" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh* ExternalFunction::getName </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="45708d6c78ab5cbbc8e39483defeea76"></a><!-- doxytag: member="ExternalFunction::getURINameHash" ref="45708d6c78ab5cbbc8e39483defeea76" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh* ExternalFunction::getURINameHash </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6edce344cc26cbee3007846c922c2973"></a><!-- doxytag: member="ExternalFunction::getNumberOfArguments" ref="6edce344cc26cbee3007846c922c2973" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int ExternalFunction::getNumberOfArguments </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="1f092fc7e07b1ff4075143282813b064"></a><!-- doxytag: member="ExternalFunction::execute" ref="1f092fc7e07b1ff4075143282813b064" args="(const Arguments *args, DynamicContext *context) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classResult.html">Result</a> ExternalFunction::execute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> * </td>
|
|
<td class="paramname"> <em>args</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="paramname"> <em>context</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Execute the (non-updating) function.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="04d1c19baeb22db53c1453efbbbb4c31"></a><!-- doxytag: member="ExternalFunction::executeUpdate" ref="04d1c19baeb22db53c1453efbbbb4c31" args="(const Arguments *args, DynamicContext *context) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual PendingUpdateList ExternalFunction::executeUpdate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> * </td>
|
|
<td class="paramname"> <em>args</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="paramname"> <em>context</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Execute the updating function.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Member Data Documentation</h2>
|
|
<a class="anchor" name="7707c9ebb2cbc37e915b849ffce4371f"></a><!-- doxytag: member="ExternalFunction::uri_" ref="7707c9ebb2cbc37e915b849ffce4371f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh* <a class="el" href="classExternalFunction.html#7707c9ebb2cbc37e915b849ffce4371f">ExternalFunction::uri_</a><code> [protected]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="9e666ea401b178e10ab3c0799b3270bd"></a><!-- doxytag: member="ExternalFunction::name_" ref="9e666ea401b178e10ab3c0799b3270bd" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh* <a class="el" href="classExternalFunction.html#9e666ea401b178e10ab3c0799b3270bd">ExternalFunction::name_</a><code> [protected]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="0ad0a21279823e2a038364827e859725"></a><!-- doxytag: member="ExternalFunction::uriName_" ref="0ad0a21279823e2a038364827e859725" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const XMLCh* <a class="el" href="classExternalFunction.html#0ad0a21279823e2a038364827e859725">ExternalFunction::uriName_</a><code> [protected]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c4803adcaf53f91a84e6a83c25571cf5"></a><!-- doxytag: member="ExternalFunction::numArgs_" ref="c4803adcaf53f91a84e6a83c25571cf5" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int <a class="el" href="classExternalFunction.html#c4803adcaf53f91a84e6a83c25571cf5">ExternalFunction::numArgs_</a><code> [protected]</code> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="ExternalFunction_8hpp-source.html">ExternalFunction.hpp</a></ul>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:54:22 2009 for XQilla Simple API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
|
|
</body>
|
|
</html>
|