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

328 lines
27 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__Sequence__s-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XQC_Sequence_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:ab84594b06f7e69fd870c41f55ae5c6c6"><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__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6">next</a> )(<a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence)</td></tr>
<tr class="memdesc:ab84594b06f7e69fd870c41f55ae5c6c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence. <a href="#ab84594b06f7e69fd870c41f55ae5c6c6">More...</a><br/></td></tr>
<tr class="separator:ab84594b06f7e69fd870c41f55ae5c6c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a280dfbbc70dade39905f4b91ed22aa19"><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#a280dfbbc70dade39905f4b91ed22aa19">get_interface</a> )(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, const char *name)</td></tr>
<tr class="memdesc:a280dfbbc70dade39905f4b91ed22aa19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to retrieve an implementation specific interface. <a href="#a280dfbbc70dade39905f4b91ed22aa19">More...</a><br/></td></tr>
<tr class="separator:a280dfbbc70dade39905f4b91ed22aa19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13ab651edb4e0754cb8a032e2bce50b0"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#a13ab651edb4e0754cb8a032e2bce50b0">free</a> )(<a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence)</td></tr>
<tr class="memdesc:a13ab651edb4e0754cb8a032e2bce50b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to free the resources associated with the XQC_Sequence. <a href="#a13ab651edb4e0754cb8a032e2bce50b0">More...</a><br/></td></tr>
<tr class="separator:a13ab651edb4e0754cb8a032e2bce50b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions on the current item</div></td></tr>
<tr class="memitem:a09c64cc1a094a915541b0d4864f8ecf9"><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__Sequence__s.html#a09c64cc1a094a915541b0d4864f8ecf9">item_type</a> )(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, <a class="el" href="xqc_8h.html#a72a7afe388d8dbc3578d5d1eb4e76cde">XQC_ItemType</a> *type)</td></tr>
<tr class="memdesc:a09c64cc1a094a915541b0d4864f8ecf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an item type enumeration for the type of the current item. <a href="#a09c64cc1a094a915541b0d4864f8ecf9">More...</a><br/></td></tr>
<tr class="separator:a09c64cc1a094a915541b0d4864f8ecf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ced435e02516a489e3a892abd1c2764"><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__Sequence__s.html#a0ced435e02516a489e3a892abd1c2764">type_name</a> )(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, const char **uri, const char **name)</td></tr>
<tr class="memdesc:a0ced435e02516a489e3a892abd1c2764"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type name for the current item as a (URI, localname) pair. <a href="#a0ced435e02516a489e3a892abd1c2764">More...</a><br/></td></tr>
<tr class="separator:a0ced435e02516a489e3a892abd1c2764"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bd3b6dab0c68652af816438407dd037"><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__Sequence__s.html#a3bd3b6dab0c68652af816438407dd037">string_value</a> )(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, const char **value)</td></tr>
<tr class="memdesc:a3bd3b6dab0c68652af816438407dd037"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the string value of the current item in the sequence - this is equivalent to calling <code>fn:string()</code> (<a href="http://www.w3.org/TR/xpath-functions/#func-string">http://www.w3.org/TR/xpath-functions/#func-string</a>) on the current item. <a href="#a3bd3b6dab0c68652af816438407dd037">More...</a><br/></td></tr>
<tr class="separator:a3bd3b6dab0c68652af816438407dd037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6f7f32f3d54ba30c043bea37e3b5fef"><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__Sequence__s.html#ac6f7f32f3d54ba30c043bea37e3b5fef">integer_value</a> )(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, int *value)</td></tr>
<tr class="memdesc:ac6f7f32f3d54ba30c043bea37e3b5fef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of the current item in the sequence as an integer - this is equivalent to calling <code>fn:number()</code> (<a href="http://www.w3.org/TR/xpath-functions/#func-number">http://www.w3.org/TR/xpath-functions/#func-number</a>) on the current item, and casting the result to an int. <a href="#ac6f7f32f3d54ba30c043bea37e3b5fef">More...</a><br/></td></tr>
<tr class="separator:ac6f7f32f3d54ba30c043bea37e3b5fef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab131f251ca020ce202e31b3bf9ff9369"><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__Sequence__s.html#ab131f251ca020ce202e31b3bf9ff9369">double_value</a> )(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, double *value)</td></tr>
<tr class="memdesc:ab131f251ca020ce202e31b3bf9ff9369"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of the current item in the sequence as a double - this is equivalent to calling <code>fn:number()</code> (<a href="http://www.w3.org/TR/xpath-functions/#func-number">http://www.w3.org/TR/xpath-functions/#func-number</a>) on the current item. <a href="#ab131f251ca020ce202e31b3bf9ff9369">More...</a><br/></td></tr>
<tr class="separator:ab131f251ca020ce202e31b3bf9ff9369"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a755d353442dd2cc25906bb0152ef8fe1"><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__Sequence__s.html#a755d353442dd2cc25906bb0152ef8fe1">node_name</a> )(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, const char **uri, const char **name)</td></tr>
<tr class="memdesc:a755d353442dd2cc25906bb0152ef8fe1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name for the current node as a (URI, localname) pair. <a href="#a755d353442dd2cc25906bb0152ef8fe1">More...</a><br/></td></tr>
<tr class="separator:a755d353442dd2cc25906bb0152ef8fe1"><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-basic_8c-example.html#_a2">xqc-basic.c</a>, and <a class="el" href="xqc-context-item_8c-example.html#_a3">xqc-context-item.c</a>.</dd>
</dl></div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ab131f251ca020ce202e31b3bf9ff9369"></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_Sequence_s::double_value)(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, double *value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value of the current item in the sequence as a double - this is equivalent to calling <code>fn:number()</code> (<a href="http://www.w3.org/TR/xpath-functions/#func-number">http://www.w3.org/TR/xpath-functions/#func-number</a>) on the current item. </p>
<p>This is available for all item types.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sequence</td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>The value of the current item as a double.</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#aeb1ad206e9c38a7f84749cafe04d7a3fa8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">next()</a> has not been called yet, or because the end of the sequence has been reached. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a13ab651edb4e0754cb8a032e2bce50b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* XQC_Sequence_s::free)(<a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to free the resources associated with the XQC_Sequence. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sequence</td><td>The XQC_Sequence 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-basic_8c-example.html#a11">xqc-basic.c</a>, and <a class="el" href="xqc-context-item_8c-example.html#a15">xqc-context-item.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a280dfbbc70dade39905f4b91ed22aa19"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* XQC_Sequence_s::get_interface)(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, 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">sequence</td><td>The XQC_Sequence 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="ac6f7f32f3d54ba30c043bea37e3b5fef"></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_Sequence_s::integer_value)(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, int *value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value of the current item in the sequence as an integer - this is equivalent to calling <code>fn:number()</code> (<a href="http://www.w3.org/TR/xpath-functions/#func-number">http://www.w3.org/TR/xpath-functions/#func-number</a>) on the current item, and casting the result to an int. </p>
<p>This is available for all item types.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sequence</td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>The value of the current item as an int.</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#aeb1ad206e9c38a7f84749cafe04d7a3fa8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">next()</a> has not been called yet, or because the end of the sequence has been reached. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a09c64cc1a094a915541b0d4864f8ecf9"></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_Sequence_s::item_type)(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, <a class="el" href="xqc_8h.html#a72a7afe388d8dbc3578d5d1eb4e76cde">XQC_ItemType</a> *type)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an item type enumeration for the type of the current item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sequence</td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">type</td><td>the XQC_ItemType of the current item</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#aeb1ad206e9c38a7f84749cafe04d7a3fa8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">next()</a> has not been called yet, or because the end of the sequence has been reached. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab84594b06f7e69fd870c41f55ae5c6c6"></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_Sequence_s::next)(<a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sequence</td><td>The XQC_Sequence that this function pointer is a member of</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>when the call is successful </td></tr>
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fadfd1d8eea45c90655b98cfd728bfee2e" title="The end of the XQC_Sequence has been reached. ">XQC_END_OF_SEQUENCE</a></td><td>when the end of the sequence is reached </td></tr>
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3faeb68302bd3ceab3cb9d9473afd06248a" title="A type error has occured while preparing or executing the query. ">XQC_TYPE_ERROR</a></td><td></td></tr>
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fa1ece0ad69a59c3f0ce59b841ded10f9d" title="A dynamic error has occured while preparing or executing the query. ">XQC_DYNAMIC_ERROR</a></td><td></td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xqc-basic_8c-example.html#a7">xqc-basic.c</a>, and <a class="el" href="xqc-context-item_8c-example.html#a9">xqc-context-item.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a755d353442dd2cc25906bb0152ef8fe1"></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_Sequence_s::node_name)(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, const char **uri, const char **name)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name for the current node as a (URI, localname) pair. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sequence</td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">uri</td><td>The URI of the name of the current node. The memory for the string will be valid until a subsequent call to <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">XQC_Sequence::next()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>The localname of the name of the current node. The memory for the string will be valid until a subsequent call to <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">XQC_Sequence::next()</a>.</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#aeb1ad206e9c38a7f84749cafe04d7a3fa8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">next()</a> has not been called yet, or because the end of the sequence has been reached. </td></tr>
<tr><td class="paramname"><a class="el" href="xqc_8h.html#aeb1ad206e9c38a7f84749cafe04d7a3fa42003308041f1f0db1d2028af432de95">XQC_NOT_NODE</a></td><td>if the current item is not a node. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3bd3b6dab0c68652af816438407dd037"></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_Sequence_s::string_value)(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, const char **value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the string value of the current item in the sequence - this is equivalent to calling <code>fn:string()</code> (<a href="http://www.w3.org/TR/xpath-functions/#func-string">http://www.w3.org/TR/xpath-functions/#func-string</a>) on the current item. </p>
<p>This is available for all item types.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sequence</td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>The string value of the current item. The memory for the string will be valid until a subsequent call to <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">XQC_Sequence::next()</a>.</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#aeb1ad206e9c38a7f84749cafe04d7a3fa8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">next()</a> has not been called yet, or because the end of the sequence has been reached. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="xqc-basic_8c-example.html#a9">xqc-basic.c</a>, and <a class="el" href="xqc-context-item_8c-example.html#a13">xqc-context-item.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0ced435e02516a489e3a892abd1c2764"></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_Sequence_s::type_name)(const <a class="el" href="xqc_8h.html#a611c8970264183d7d0f42a8551239463">XQC_Sequence</a> *sequence, const char **uri, const char **name)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the type name for the current item as a (URI, localname) pair. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">sequence</td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">uri</td><td>The URI of the type of the current item. The memory for the string will be valid until a subsequent call to <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">XQC_Sequence::next()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>The localname of the type of the current item. The memory for the string will be valid until a subsequent call to <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">XQC_Sequence::next()</a>.</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#aeb1ad206e9c38a7f84749cafe04d7a3fa8e49ef7f25ae9121a0b59bc4cd050f5b">XQC_NO_CURRENT_ITEM</a></td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#ab84594b06f7e69fd870c41f55ae5c6c6" title="Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence...">next()</a> has not been called yet, or because the end of the sequence has been reached. </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