388 lines
24 KiB
HTML
388 lines
24 KiB
HTML
<!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&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 Page</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
|
|
<h1>XQC_Sequence_s Struct Reference</h1><code>#include <<a class="el" href="xqc_8h-source.html">xqc.h</a>></code>
|
|
<p>
|
|
<a href="structXQC__Sequence__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>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#o0">next</a> )(<a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence. <a href="#o0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#o1">get_interface</a> )(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char *name)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to retrieve an implementation specific interface. <a href="#o1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#o2">free</a> )(<a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to free the resources associated with the XQC_Sequence. <a href="#o2"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Functions on the current item</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#z3_0">item_type</a> )(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, <a class="el" href="xqc_8h.html#a67">XQC_ItemType</a> *type)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an item type enumeration for the type of the current item. <a href="#z3_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#z3_1">type_name</a> )(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char **uri, const char **name)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type name for the current item as a (URI, localname) pair. <a href="#z3_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#z3_2">string_value</a> )(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char **value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="#z3_2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#z3_3">integer_value</a> )(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, int *value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="#z3_3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#z3_4">double_value</a> )(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, double *value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="#z3_4"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xqc_8h.html#a66">XQC_Error</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structXQC__Sequence__s.html#z3_5">node_name</a> )(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char **uri, const char **name)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name for the current node as a (URI, localname) pair. <a href="#z3_5"></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-basic_8c-example.html#_a2">xqc-basic.c</a>, and <a class="el" href="xqc-context-item_8c-example.html#_a14">xqc-context-item.c</a>.</dl>
|
|
<p>
|
|
<hr><h2>Member Data Documentation</h2>
|
|
<a class="anchor" name="z3_4" doxytag="XQC_Sequence_s::double_value"></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__Sequence__s.html#z3_4">XQC_Sequence_s::double_value</a>)(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, double *value) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
This is available for all item types.<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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>value</em> </td><td>The value of the current item as a double.</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> </td><td></td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_NO_CURRENT_ITEM</em> </td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#o0">next()</a> has not been called yet, or because the end of the sequence has been reached.</td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o2" doxytag="XQC_Sequence_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__Sequence__s.html#o2">XQC_Sequence_s::free</a>)(<a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Called to free the resources associated with the XQC_Sequence.
|
|
<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>sequence</em> </td><td>The XQC_Sequence 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-basic_8c-example.html#a8">xqc-basic.c</a>, and <a class="el" href="xqc-context-item_8c-example.html#a23">xqc-context-item.c</a>.</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o1" doxytag="XQC_Sequence_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__Sequence__s.html#o1">XQC_Sequence_s::get_interface</a>)(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char *name) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </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="z3_3" doxytag="XQC_Sequence_s::integer_value"></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__Sequence__s.html#z3_3">XQC_Sequence_s::integer_value</a>)(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, int *value) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
This is available for all item types.<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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>value</em> </td><td>The value of the current item as an int.</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> </td><td></td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_NO_CURRENT_ITEM</em> </td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#o0">next()</a> has not been called yet, or because the end of the sequence has been reached.</td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z3_0" doxytag="XQC_Sequence_s::item_type"></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__Sequence__s.html#z3_0">XQC_Sequence_s::item_type</a>)(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, <a class="el" href="xqc_8h.html#a67">XQC_ItemType</a> *type) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns an item type enumeration for the type of the current item.
|
|
<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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>type</em> </td><td>the XQC_ItemType of the current item</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> </td><td></td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_NO_CURRENT_ITEM</em> </td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#o0">next()</a> has not been called yet, or because the end of the sequence has been reached.</td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="o0" doxytag="XQC_Sequence_s::next"></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__Sequence__s.html#o0">XQC_Sequence_s::next</a>)(<a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Moves the XQC_Sequence so that the current item is positioned at the next item in the sequence.
|
|
<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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of</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> </td><td>when the call is successful </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_END_OF_SEQUENCE</em> </td><td>when the end of the sequence is reached </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_TYPE_ERROR</em> </td><td></td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_DYNAMIC_ERROR</em> </td><td></td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Examples: </b></dt><dd>
|
|
<a class="el" href="xqc-basic_8c-example.html#a6">xqc-basic.c</a>, and <a class="el" href="xqc-context-item_8c-example.html#a19">xqc-context-item.c</a>.</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z3_5" doxytag="XQC_Sequence_s::node_name"></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__Sequence__s.html#z3_5">XQC_Sequence_s::node_name</a>)(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char **uri, const char **name) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns the name for the current node as a (URI, localname) pair.
|
|
<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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>uri</em> </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#o0">XQC_Sequence::next()</a>. </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>name</em> </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#o0">XQC_Sequence::next()</a>.</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> </td><td></td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_NO_CURRENT_ITEM</em> </td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#o0">next()</a> has not been called yet, or because the end of the sequence has been reached. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_NOT_NODE</em> </td><td>if the current item is not a node.</td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z3_2" doxytag="XQC_Sequence_s::string_value"></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__Sequence__s.html#z3_2">XQC_Sequence_s::string_value</a>)(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char **value) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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>
|
|
This is available for all item types.<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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>value</em> </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#o0">XQC_Sequence::next()</a>.</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> </td><td></td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_NO_CURRENT_ITEM</em> </td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#o0">next()</a> has not been called yet, or because the end of the sequence has been reached.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><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#a22">xqc-context-item.c</a>.</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z3_1" doxytag="XQC_Sequence_s::type_name"></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__Sequence__s.html#z3_1">XQC_Sequence_s::type_name</a>)(const <a class="el" href="structXQC__Sequence__s.html">XQC_Sequence</a> *sequence, const char **uri, const char **name) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Returns the type name for the current item as a (URI, localname) pair.
|
|
<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>sequence</em> </td><td>The XQC_Sequence that this function pointer is a member of </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>uri</em> </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#o0">XQC_Sequence::next()</a>. </td></tr>
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>name</em> </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#o0">XQC_Sequence::next()</a>.</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> </td><td></td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>::XQC_NO_CURRENT_ITEM</em> </td><td>if there is no current item, either because <a class="el" href="structXQC__Sequence__s.html#o0">next()</a> has not been called yet, or because the end of the sequence has been reached.</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
|
|
<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>
|