mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/xqc-api/structXQC__DynamicContext__s.html
King_DuckZ 1613a190f0 v2.2.2
2020-02-17 22:19:08 +01:00

342 lines
18 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.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>XQC_DynamicContext_s Struct Reference</h1><code>#include &lt;<a class="el" href="xqc_8h-source.html">xqc.h</a>&gt;</code>
<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#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o0">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="#o0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o1">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#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o2">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="#o2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o3">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#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o4">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="#o4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o5">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#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o6">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#a66">XQC_Error</a>(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__DynamicContext__s.html#o7">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#o8">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="#o8"></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#o9">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="#o9"></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#_a13">xqc-context-item.c</a>.</dl>
<p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o9" doxytag="XQC_DynamicContext_s::free"></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">void(* <a class="el" href="structXQC__DynamicContext__s.html#o9">XQC_DynamicContext_s::free</a>)(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context) </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<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#a24">xqc-context-item.c</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="o3" doxytag="XQC_DynamicContext_s::get_context_item"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o3">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="o7" doxytag="XQC_DynamicContext_s::get_error_handler"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o7">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="o5" doxytag="XQC_DynamicContext_s::get_implicit_timezone"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o5">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="o8" doxytag="XQC_DynamicContext_s::get_interface"></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">void*(* <a class="el" href="structXQC__DynamicContext__s.html#o8">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<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 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>
</td>
</tr>
</table>
<a class="anchor" name="o1" doxytag="XQC_DynamicContext_s::get_variable"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o1">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="o2" doxytag="XQC_DynamicContext_s::set_context_item"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o2">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<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>::XQC_NO_ERROR</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>::XQC_INTERNAL_ERROR</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>::XQC_NO_CURRENT_ITEM</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#a20">xqc-context-item.c</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="o6" doxytag="XQC_DynamicContext_s::set_error_handler"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o6">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="o4" doxytag="XQC_DynamicContext_s::set_implicit_timezone"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o4">XQC_DynamicContext_s::set_implicit_timezone</a>)(<a class="el" href="structXQC__DynamicContext__s.html">XQC_DynamicContext</a> *context, int timezone) </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<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>
</td>
</tr>
</table>
<a class="anchor" name="o0" doxytag="XQC_DynamicContext_s::set_variable"></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"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* <a class="el" href="structXQC__DynamicContext__s.html#o0">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>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<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>::XQC_NO_ERROR</em>&nbsp;</td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>::XQC_INTERNAL_ERROR</em>&nbsp;</td><td></td></tr>
</table>
</dl>
</td>
</tr>
</table>
<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>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:57 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.3.9.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink