mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/xqc-api/structXQC__DynamicContext__s.html
King_DuckZ 4bc0157dcd v2.2.0
2020-02-17 22:17:06 +01:00

279 lines
20 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 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.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>XQC_DynamicContext_s Struct Reference</h1><!-- doxytag: class="XQC_DynamicContext_s" --><code>#include &lt;<a class="el" href="xqc_8h-source.html">xqc.h</a>&gt;</code>
<p>
<p>
<a href="structXQC__DynamicContext__s-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 Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#28763890c7f5031afe80ecb2d46d9fe2">set_variable</a> )(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the external variable to the value given. <a href="#28763890c7f5031afe80ecb2d46d9fe2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#e78ba50e69321444c11d14b1ee406df0">get_variable</a> )(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> **value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#0c69d262bfe4fd038832db4e4db600af">set_context_item</a> )(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the context item to the current item of the XQC_Sequence given. <a href="#0c69d262bfe4fd038832db4e4db600af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#b698b8041093ef047fa6657df841279e">get_context_item</a> )(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> **value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#1920a035b369949457f7a5a091dc33be">set_implicit_timezone</a> )(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, int timezone)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The timezone given must be between -840 and +840 minutes (-14 and +14 hours). <a href="#1920a035b369949457f7a5a091dc33be"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#109602078ee31ab10bf500def8d932ef">get_implicit_timezone</a> )(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, int *timezone)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#da19b7ea30122707a79b9e02c871874c">set_error_handler</a> )(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__ErrorHandler__s.html">XQC_ErrorHandler</a> *handler)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#7b3dfc5fd966a416505c5f620482d821">get_error_handler</a> )(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__ErrorHandler__s.html">XQC_ErrorHandler</a> **handler)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#2bc30d8a8f5e28ad57eababd6cfc0c36">get_interface</a> )(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, const char *name)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to retrieve an implementation specific interface. <a href="#2bc30d8a8f5e28ad57eababd6cfc0c36"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#d40117a7e2dd660ea7478c4cc5124eab">free</a> )(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to free the resources associated with the XQC_DynamicContext. <a href="#d40117a7e2dd660ea7478c4cc5124eab"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="xqc-context-item_8c-example.html#_a2">xqc-context-item.c</a>.</dl><hr><h2>Member Data Documentation</h2>
<a class="anchor" name="28763890c7f5031afe80ecb2d46d9fe2"></a><!-- doxytag: member="XQC_DynamicContext_s::set_variable" ref="28763890c7f5031afe80ecb2d46d9fe2" args=")(XQC_DynamicContext *context, const char *uri, const char *name, XQC_Sequence *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#28763890c7f5031afe80ecb2d46d9fe2">XQC_DynamicContext_s::set_variable</a>)(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *value) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the external variable to the value given.
<p>
The implementation takes ownership of the XQC_Sequence passed in, and is responsible for freeing it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uri</em>&nbsp;</td><td>The namespace URI of the external variable to set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</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 valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The XQC_Sequence value for the variable, or 0 to remove the existing binding for the variable.</td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f975a11c6557d4d849e48f4034380a375" title="No error.">XQC_NO_ERROR</a></em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f01b5565965d03299df81f0916b8fa768" title="An implementation specific error has occurred.">XQC_INTERNAL_ERROR</a></em>&nbsp;</td><td></td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e78ba50e69321444c11d14b1ee406df0"></a><!-- doxytag: member="XQC_DynamicContext_s::get_variable" ref="e78ba50e69321444c11d14b1ee406df0" args=")(const XQC_DynamicContext *context, const char *uri, const char *name, XQC_Sequence **value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#e78ba50e69321444c11d14b1ee406df0">XQC_DynamicContext_s::get_variable</a>)(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, const char *uri, const char *name, <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> **value) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0c69d262bfe4fd038832db4e4db600af"></a><!-- doxytag: member="XQC_DynamicContext_s::set_context_item" ref="0c69d262bfe4fd038832db4e4db600af" args=")(XQC_DynamicContext *context, XQC_Sequence *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#0c69d262bfe4fd038832db4e4db600af">XQC_DynamicContext_s::set_context_item</a>)(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__Sequence__s.html">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>
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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The XQC_Sequence value for the context item, or 0 to remove the existing context item value.</td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f975a11c6557d4d849e48f4034380a375" title="No error.">XQC_NO_ERROR</a></em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f01b5565965d03299df81f0916b8fa768" title="An implementation specific error has occurred.">XQC_INTERNAL_ERROR</a></em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></em>&nbsp;</td><td>if there is no current item in the value.</td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xqc-context-item_8c-example.html#a10">xqc-context-item.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="b698b8041093ef047fa6657df841279e"></a><!-- doxytag: member="XQC_DynamicContext_s::get_context_item" ref="b698b8041093ef047fa6657df841279e" args=")(const XQC_DynamicContext *context, XQC_Sequence **value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#b698b8041093ef047fa6657df841279e">XQC_DynamicContext_s::get_context_item</a>)(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> **value) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="1920a035b369949457f7a5a091dc33be"></a><!-- doxytag: member="XQC_DynamicContext_s::set_implicit_timezone" ref="1920a035b369949457f7a5a091dc33be" args=")(XQC_DynamicContext *context, int timezone)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#1920a035b369949457f7a5a091dc33be">XQC_DynamicContext_s::set_implicit_timezone</a>)(<a class="el" href="structXQC__DynamicContext__s.html">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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timezone</em>&nbsp;</td><td>The implicit timezone to set, as an offset in minutes from GMT </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="109602078ee31ab10bf500def8d932ef"></a><!-- doxytag: member="XQC_DynamicContext_s::get_implicit_timezone" ref="109602078ee31ab10bf500def8d932ef" args=")(const XQC_DynamicContext *context, int *timezone)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#109602078ee31ab10bf500def8d932ef">XQC_DynamicContext_s::get_implicit_timezone</a>)(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, int *timezone) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="da19b7ea30122707a79b9e02c871874c"></a><!-- doxytag: member="XQC_DynamicContext_s::set_error_handler" ref="da19b7ea30122707a79b9e02c871874c" args=")(XQC_DynamicContext *context, XQC_ErrorHandler *handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#da19b7ea30122707a79b9e02c871874c">XQC_DynamicContext_s::set_error_handler</a>)(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__ErrorHandler__s.html">XQC_ErrorHandler</a> *handler) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7b3dfc5fd966a416505c5f620482d821"></a><!-- doxytag: member="XQC_DynamicContext_s::get_error_handler" ref="7b3dfc5fd966a416505c5f620482d821" args=")(const XQC_DynamicContext *context, XQC_ErrorHandler **handler)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xqc_8h.html#eb1ad206e9c38a7f84749cafe04d7a3f">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#7b3dfc5fd966a416505c5f620482d821">XQC_DynamicContext_s::get_error_handler</a>)(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, <a class="el" href="structXQC__ErrorHandler__s.html">XQC_ErrorHandler</a> **handler) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2bc30d8a8f5e28ad57eababd6cfc0c36"></a><!-- doxytag: member="XQC_DynamicContext_s::get_interface" ref="2bc30d8a8f5e28ad57eababd6cfc0c36" args=")(const XQC_DynamicContext *context, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* <a class="el" href="structXQC__DynamicContext__s.html#2bc30d8a8f5e28ad57eababd6cfc0c36">XQC_DynamicContext_s::get_interface</a>)(const <a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, const char *name) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called to retrieve an implementation specific interface.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>The name that identifies the interface to return</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the interface, or 0 if the name is not recognized by this implementation of XQC. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d40117a7e2dd660ea7478c4cc5124eab"></a><!-- doxytag: member="XQC_DynamicContext_s::free" ref="d40117a7e2dd660ea7478c4cc5124eab" args=")(XQC_DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structXQC__DynamicContext__s.html#d40117a7e2dd660ea7478c4cc5124eab">XQC_DynamicContext_s::free</a>)(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called to free the resources associated with the XQC_DynamicContext.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>The XQC_DynamicContext that this function pointer is a member of </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="xqc-context-item_8c-example.html#a16">xqc-context-item.c</a>.</dl>
</div>
</div><p>
<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></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:54:59 2009 for XQilla XQC API by&nbsp;
<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>
Reference in a new issue View git blame Copy permalink