mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/xqc-api/structXQC__DynamicContext__s.html
King_DuckZ 3552e76c6c v2.3.4
2020-02-17 22:24:47 +01:00

262 lines
19 KiB
HTML
Raw Permalink 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 XQC 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.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structXQC__DynamicContext__s-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XQC_DynamicContext_s Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="xqc_8h_source.html">xqc.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a28763890c7f5031afe80ecb2d46d9fe2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#a28763890c7f5031afe80ecb2d46d9fe2">set_variable</a> )(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *value)</td></tr>
<tr class="memdesc:a28763890c7f5031afe80ecb2d46d9fe2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the external variable to the value given. <a href="#a28763890c7f5031afe80ecb2d46d9fe2">More...</a><br/></td></tr>
<tr class="separator:a28763890c7f5031afe80ecb2d46d9fe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae78ba50e69321444c11d14b1ee406df0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#ae78ba50e69321444c11d14b1ee406df0">get_variable</a> )(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> **value)</td></tr>
<tr class="separator:ae78ba50e69321444c11d14b1ee406df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c69d262bfe4fd038832db4e4db600af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#a0c69d262bfe4fd038832db4e4db600af">set_context_item</a> )(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *value)</td></tr>
<tr class="memdesc:a0c69d262bfe4fd038832db4e4db600af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the context item to the current item of the XQC_Sequence given. <a href="#a0c69d262bfe4fd038832db4e4db600af">More...</a><br/></td></tr>
<tr class="separator:a0c69d262bfe4fd038832db4e4db600af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab698b8041093ef047fa6657df841279e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#ab698b8041093ef047fa6657df841279e">get_context_item</a> )(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> **value)</td></tr>
<tr class="separator:ab698b8041093ef047fa6657df841279e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1920a035b369949457f7a5a091dc33be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#a1920a035b369949457f7a5a091dc33be">set_implicit_timezone</a> )(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, int timezone)</td></tr>
<tr class="memdesc:a1920a035b369949457f7a5a091dc33be"><td class="mdescLeft">&#160;</td><td class="mdescRight">The timezone given must be between -840 and +840 minutes (-14 and +14 hours). <a href="#a1920a035b369949457f7a5a091dc33be">More...</a><br/></td></tr>
<tr class="separator:a1920a035b369949457f7a5a091dc33be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a109602078ee31ab10bf500def8d932ef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#a109602078ee31ab10bf500def8d932ef">get_implicit_timezone</a> )(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, int *timezone)</td></tr>
<tr class="separator:a109602078ee31ab10bf500def8d932ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada19b7ea30122707a79b9e02c871874c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#ada19b7ea30122707a79b9e02c871874c">set_error_handler</a> )(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#ac30b575982cfb24206404168dbd0bff0">XQC_ErrorHandler</a> *handler)</td></tr>
<tr class="separator:ada19b7ea30122707a79b9e02c871874c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b3dfc5fd966a416505c5f620482d821"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#a7b3dfc5fd966a416505c5f620482d821">get_error_handler</a> )(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#ac30b575982cfb24206404168dbd0bff0">XQC_ErrorHandler</a> **handler)</td></tr>
<tr class="separator:a7b3dfc5fd966a416505c5f620482d821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bc30d8a8f5e28ad57eababd6cfc0c36"><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#a2bc30d8a8f5e28ad57eababd6cfc0c36">get_interface</a> )(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, const char *name)</td></tr>
<tr class="memdesc:a2bc30d8a8f5e28ad57eababd6cfc0c36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to retrieve an implementation specific interface. <a href="#a2bc30d8a8f5e28ad57eababd6cfc0c36">More...</a><br/></td></tr>
<tr class="separator:a2bc30d8a8f5e28ad57eababd6cfc0c36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad40117a7e2dd660ea7478c4cc5124eab"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#ad40117a7e2dd660ea7478c4cc5124eab">free</a> )(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context)</td></tr>
<tr class="memdesc:ad40117a7e2dd660ea7478c4cc5124eab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to free the resources associated with the XQC_DynamicContext. <a href="#ad40117a7e2dd660ea7478c4cc5124eab">More...</a><br/></td></tr>
<tr class="separator:ad40117a7e2dd660ea7478c4cc5124eab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl><dt><b>Examples: </b></dt><dd><a class="el" href="xqc-context-item_8c-example.html#_a2">xqc-context-item.c</a>.</dd>
</dl></div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ad40117a7e2dd660ea7478c4cc5124eab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* XQC_DynamicContext_s::free)(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to free the resources associated with the XQC_DynamicContext. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xqc-context-item_8c-example.html#a16">xqc-context-item.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab698b8041093ef047fa6657df841279e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::get_context_item)(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> **value)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7b3dfc5fd966a416505c5f620482d821"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::get_error_handler)(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#ac30b575982cfb24206404168dbd0bff0">XQC_ErrorHandler</a> **handler)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a109602078ee31ab10bf500def8d932ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::get_implicit_timezone)(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, int *timezone)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2bc30d8a8f5e28ad57eababd6cfc0c36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* XQC_DynamicContext_s::get_interface)(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, const char *name)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to retrieve an implementation specific interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
<tr><td class="paramname">name</td><td>The name that identifies the interface to return</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the interface, or 0 if the name is not recognized by this implementation of XQC. </dd></dl>
</div>
</div>
<a class="anchor" id="ae78ba50e69321444c11d14b1ee406df0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::get_variable)(const <a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> **value)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0c69d262bfe4fd038832db4e4db600af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::set_context_item)(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the context item to the current item of the XQC_Sequence given. </p>
<p>The user remains responsible for freeing the XQC_Sequence passed as the value - the XQC_Sequence must not be freed until the XQC_DynamicContext has been freed or it's context item set to a different value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
<tr><td class="paramname">value</td><td>The XQC_Sequence value for the context item, or 0 to remove the existing context item value.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fa975a11c6557d4d849e48f4034380a375" title="No error. ">XQC_NO_ERROR</a></td><td></td></tr>
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fa01b5565965d03299df81f0916b8fa768" title="An implementation specific error has occurred. ">XQC_INTERNAL_ERROR</a></td><td></td></tr>
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fa8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></td><td>if there is no current item in the value.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xqc-context-item_8c-example.html#a10">xqc-context-item.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ada19b7ea30122707a79b9e02c871874c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::set_error_handler)(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, <a class="el" href="xqc_8h.html#ac30b575982cfb24206404168dbd0bff0">XQC_ErrorHandler</a> *handler)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1920a035b369949457f7a5a091dc33be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::set_implicit_timezone)(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, int timezone)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The timezone given must be between -840 and +840 minutes (-14 and +14 hours). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timezone</td><td>The implicit timezone to set, as an offset in minutes from GMT </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a28763890c7f5031afe80ecb2d46d9fe2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* XQC_DynamicContext_s::set_variable)(<a class="el" href="xqc_8h.html#acf4c0769616363086377cb527484d33e">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the external variable to the value given. </p>
<p>The implementation takes ownership of the XQC_Sequence passed in, and is responsible for freeing it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
<tr><td class="paramname">uri</td><td>The namespace URI of the external variable to set. </td></tr>
<tr><td class="paramname">name</td><td>The name of the external variable to set - this should be a valid lexical <code>xs:QName</code>. If <code>uri</code> is 0 and <code>name</code> has a prefix, that prefix is resolved using the in-scope namespace prefixes for the expression. </td></tr>
<tr><td class="paramname">value</td><td>The XQC_Sequence value for the variable, or 0 to remove the existing binding for the variable.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fa975a11c6557d4d849e48f4034380a375" title="No error. ">XQC_NO_ERROR</a></td><td></td></tr>
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fa01b5565965d03299df81f0916b8fa768" title="An implementation specific error has occurred. ">XQC_INTERNAL_ERROR</a></td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xqc_8h_source.html">xqc.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink