mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/classExternalFunction.html
King_DuckZ c04629cb7b v2.1.2
2020-02-17 22:14:54 +01:00

327 lines
15 KiB
HTML
Raw Blame History

<!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&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>ExternalFunction Class Reference</h1><!-- doxytag: class="ExternalFunction" --><code>#include &lt;<a class="el" href="ExternalFunction_8hpp-source.html">ExternalFunction.hpp</a>&gt;</code>
<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&nbsp;</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 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a80e3f5ce4d1b285554cc28232cb3676">getURI</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#344792dc1dad079ac19692bcd9a3853b">getName</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#b5e66b9364a9bda9f7dee86f70ec8e01">getURINameHash</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#9560c3d8ae785f2b0d90a7b48457464c">getNumberOfArguments</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classResult.html">Result</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#3cbd6dc3e7ba7bebd9f9cf422ee2c6d7">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">&nbsp;</td><td class="mdescRight">Execute the (non-updating) function. <a href="#3cbd6dc3e7ba7bebd9f9cf422ee2c6d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PendingUpdateList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#f1506cc51f9e9c71afd77969fc2284a4">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">&nbsp;</td><td class="mdescRight">Execute the updating function. <a href="#f1506cc51f9e9c71afd77969fc2284a4"></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">&nbsp;</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 *&nbsp;</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 *&nbsp;</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 *&nbsp;</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&nbsp;</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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a></td></tr>
</table>
<hr><h2>Constructor &amp; 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>&nbsp;)&nbsp;</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 *&nbsp;</td>
<td class="paramname"> <em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</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> *&nbsp;</td>
<td class="paramname"> <em>mm</em></td><td>&nbsp;</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="a80e3f5ce4d1b285554cc28232cb3676"></a><!-- doxytag: member="ExternalFunction::getURI" ref="a80e3f5ce4d1b285554cc28232cb3676" 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>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="344792dc1dad079ac19692bcd9a3853b"></a><!-- doxytag: member="ExternalFunction::getName" ref="344792dc1dad079ac19692bcd9a3853b" 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>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b5e66b9364a9bda9f7dee86f70ec8e01"></a><!-- doxytag: member="ExternalFunction::getURINameHash" ref="b5e66b9364a9bda9f7dee86f70ec8e01" 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>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9560c3d8ae785f2b0d90a7b48457464c"></a><!-- doxytag: member="ExternalFunction::getNumberOfArguments" ref="9560c3d8ae785f2b0d90a7b48457464c" 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>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3cbd6dc3e7ba7bebd9f9cf422ee2c6d7"></a><!-- doxytag: member="ExternalFunction::execute" ref="3cbd6dc3e7ba7bebd9f9cf422ee2c6d7" 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> *&nbsp;</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> *&nbsp;</td>
<td class="paramname"> <em>context</em></td><td>&nbsp;</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="f1506cc51f9e9c71afd77969fc2284a4"></a><!-- doxytag: member="ExternalFunction::executeUpdate" ref="f1506cc51f9e9c71afd77969fc2284a4" 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> *&nbsp;</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> *&nbsp;</td>
<td class="paramname"> <em>context</em></td><td>&nbsp;</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>
<hr size="1"><address style="align: right;"><small>Generated on Mon Apr 28 16:41:08 2008 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink