| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>Query Results</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| 7 |
<link rel="home" href="index.html" title="Rasqal RDF Query Library Manual"> |
| 8 |
<link rel="up" href="reference-manual.html" title="Part I. Reference Manual"> |
| 9 |
<link rel="prev" href="rasqal-section-query.html" title="Query"> |
| 10 |
<link rel="next" href="rasqal-section-query-results-formatter.html" title="Query Results Formatter"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> |
| 16 |
<tr valign="middle"> |
| 17 |
<td><a accesskey="p" href="rasqal-section-query.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| 18 |
<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> |
| 19 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> |
| 20 |
<th width="100%" align="center">Rasqal RDF Query Library Manual</th> |
| 21 |
<td><a accesskey="n" href="rasqal-section-query-results-formatter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| 22 |
</tr> |
| 23 |
<tr><td colspan="5" class="shortcuts"> |
| 24 |
<a href="#rasqal-section-query-results.synopsis" class="shortcut">Top</a> |
| 25 |
| |
| 26 |
<a href="#rasqal-section-query-results.description" class="shortcut">Description</a> |
| 27 |
</td></tr> |
| 28 |
</table> |
| 29 |
<div class="refentry"> |
| 30 |
<a name="rasqal-section-query-results"></a><div class="titlepage"></div> |
| 31 |
<div class="refnamediv"><table width="100%"><tr> |
| 32 |
<td valign="top"> |
| 33 |
<h2><span class="refentrytitle"><a name="rasqal-section-query-results.top_of_page"></a>Query Results</span></h2> |
| 34 |
<p>Query Results — Query results as variable bindings, boolean or RDF graphs.</p> |
| 35 |
</td> |
| 36 |
<td valign="top" align="right"></td> |
| 37 |
</tr></table></div> |
| 38 |
<div class="refsynopsisdiv"> |
| 39 |
<a name="rasqal-section-query-results.synopsis"></a><h2>Synopsis</h2> |
| 40 |
<pre class="synopsis">typedef <a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a>; |
| 41 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="returnvalue">rasqal_query_results</span></a> * <a class="link" href="rasqal-section-query-results.html#rasqal-new-query-results" title="rasqal_new_query_results ()">rasqal_new_query_results</a> (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 42 |
<em class="parameter"><code><a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="type">rasqal_query</span></a> *query</code></em>, |
| 43 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>, |
| 44 |
<em class="parameter"><code><a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table"><span class="type">rasqal_variables_table</span></a> *vars_table</code></em>); |
| 45 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="returnvalue">rasqal_query_results</span></a> * <a class="link" href="rasqal-section-query-results.html#rasqal-new-query-results2" title="rasqal_new_query_results2 ()">rasqal_new_query_results2</a> (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 46 |
<em class="parameter"><code><a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="type">rasqal_query</span></a> *query</code></em>, |
| 47 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>); |
| 48 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="returnvalue">rasqal_query_results</span></a> * <a class="link" href="rasqal-section-query-results.html#rasqal-new-query-results-from-string" title="rasqal_new_query_results_from_string ()">rasqal_new_query_results_from_string</a> |
| 49 |
(<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 50 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>, |
| 51 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>, |
| 52 |
<em class="parameter"><code>const <span class="type">char</span> *string</code></em>, |
| 53 |
<em class="parameter"><code><span class="type">size_t</span> string_len</code></em>); |
| 54 |
<span class="returnvalue">void</span> <a class="link" href="rasqal-section-query-results.html#rasqal-free-query-results" title="rasqal_free_query_results ()">rasqal_free_query_results</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 55 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-add-row" title="rasqal_query_results_add_row ()">rasqal_query_results_add_row</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 56 |
<em class="parameter"><code><a class="link" href="rasqal-section-row.html#rasqal-row" title="rasqal_row"><span class="type">rasqal_row</span></a> *row</code></em>); |
| 57 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-finished" title="rasqal_query_results_finished ()">rasqal_query_results_finished</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 58 |
const unsigned <span class="returnvalue">char</span> * <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-binding-name" title="rasqal_query_results_get_binding_name ()">rasqal_query_results_get_binding_name</a> |
| 59 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 60 |
<em class="parameter"><code><span class="type">int</span> offset</code></em>); |
| 61 |
<a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="returnvalue">rasqal_literal</span></a> * <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-binding-value" title="rasqal_query_results_get_binding_value ()">rasqal_query_results_get_binding_value</a> |
| 62 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 63 |
<em class="parameter"><code><span class="type">int</span> offset</code></em>); |
| 64 |
<a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="returnvalue">rasqal_literal</span></a> * <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-binding-value-by-name" title="rasqal_query_results_get_binding_value_by_name ()">rasqal_query_results_get_binding_value_by_name</a> |
| 65 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 66 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>); |
| 67 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-bindings" title="rasqal_query_results_get_bindings ()">rasqal_query_results_get_bindings</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 68 |
<em class="parameter"><code>const unsigned <span class="type">char</span> ***names</code></em>, |
| 69 |
<em class="parameter"><code><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> ***values</code></em>); |
| 70 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-bindings-count" title="rasqal_query_results_get_bindings_count ()">rasqal_query_results_get_bindings_count</a> |
| 71 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 72 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-boolean" title="rasqal_query_results_get_boolean ()">rasqal_query_results_get_boolean</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 73 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-count" title="rasqal_query_results_get_count ()">rasqal_query_results_get_count</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 74 |
<a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="returnvalue">rasqal_query</span></a> * <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-query" title="rasqal_query_results_get_query ()">rasqal_query_results_get_query</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 75 |
<span class="returnvalue">raptor_statement</span> * <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-triple" title="rasqal_query_results_get_triple ()">rasqal_query_results_get_triple</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 76 |
<a class="link" href="rasqal-section-row.html#rasqal-row" title="rasqal_row"><span class="returnvalue">rasqal_row</span></a> * <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-row-by-offset" title="rasqal_query_results_get_row_by_offset ()">rasqal_query_results_get_row_by_offset</a> |
| 77 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 78 |
<em class="parameter"><code><span class="type">int</span> result_offset</code></em>); |
| 79 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="returnvalue">rasqal_query_results_type</span></a> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-type" title="rasqal_query_results_get_type ()">rasqal_query_results_get_type</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 80 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-is-bindings" title="rasqal_query_results_is_bindings ()">rasqal_query_results_is_bindings</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 81 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-is-boolean" title="rasqal_query_results_is_boolean ()">rasqal_query_results_is_boolean</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 82 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-is-graph" title="rasqal_query_results_is_graph ()">rasqal_query_results_is_graph</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 83 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-is-syntax" title="rasqal_query_results_is_syntax ()">rasqal_query_results_is_syntax</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 84 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-next" title="rasqal_query_results_next ()">rasqal_query_results_next</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 85 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-next-triple" title="rasqal_query_results_next_triple ()">rasqal_query_results_next_triple</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 86 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-read" title="rasqal_query_results_read ()">rasqal_query_results_read</a> (<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 87 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 88 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 89 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 90 |
<em class="parameter"><code><span class="type">raptor_uri</span> *format_uri</code></em>, |
| 91 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>); |
| 92 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-write" title="rasqal_query_results_write ()">rasqal_query_results_write</a> (<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 93 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 94 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 95 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 96 |
<em class="parameter"><code><span class="type">raptor_uri</span> *format_uri</code></em>, |
| 97 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>); |
| 98 |
enum <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type">rasqal_query_results_type</a>; |
| 99 |
const <span class="returnvalue">char</span> * <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type-label" title="rasqal_query_results_type_label ()">rasqal_query_results_type_label</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>); |
| 100 |
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-rewind" title="rasqal_query_results_rewind ()">rasqal_query_results_rewind</a> (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>); |
| 101 |
</pre> |
| 102 |
</div> |
| 103 |
<div class="refsect1"> |
| 104 |
<a name="rasqal-section-query-results.description"></a><h2>Description</h2> |
| 105 |
<p> |
| 106 |
A query results object is only ever constructed by the internal |
| 107 |
query engine evaluating a <a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="type">rasqal_query</span></a> with <a class="link" href="rasqal-section-query.html#rasqal-query-execute" title="rasqal_query_execute ()"><code class="function">rasqal_query_execute()</code></a>. |
| 108 |
It provides interface to the multiple types of result supported. |
| 109 |
</p> |
| 110 |
<p> |
| 111 |
There are a large set of methods for returning all or parts of a |
| 112 |
variable binding query result including the names, values or |
| 113 |
individuals. A boolean result is straightforward to get with |
| 114 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results-get-boolean" title="rasqal_query_results_get_boolean ()"><code class="function">rasqal_query_results_get_boolean()</code></a> and an RDF graph returns a |
| 115 |
sequence of raptor triples than can be easily passed to the Raptor |
| 116 |
library for serializing to a syntax. |
| 117 |
</p> |
| 118 |
</div> |
| 119 |
<div class="refsect1"> |
| 120 |
<a name="rasqal-section-query-results.details"></a><h2>Details</h2> |
| 121 |
<div class="refsect2"> |
| 122 |
<a name="rasqal-query-results"></a><h3>rasqal_query_results</h3> |
| 123 |
<pre class="programlisting">rasqal_graph_query_results* query_results; |
| 124 |
</pre> |
| 125 |
<p> |
| 126 |
Rasqal query results class. |
| 127 |
</p> |
| 128 |
</div> |
| 129 |
<hr> |
| 130 |
<div class="refsect2"> |
| 131 |
<a name="rasqal-new-query-results"></a><h3>rasqal_new_query_results ()</h3> |
| 132 |
<pre class="programlisting"><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="returnvalue">rasqal_query_results</span></a> * rasqal_new_query_results (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 133 |
<em class="parameter"><code><a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="type">rasqal_query</span></a> *query</code></em>, |
| 134 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>, |
| 135 |
<em class="parameter"><code><a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table"><span class="type">rasqal_variables_table</span></a> *vars_table</code></em>);</pre> |
| 136 |
<p> |
| 137 |
Constructor - create a new query results set |
| 138 |
</p> |
| 139 |
<p> |
| 140 |
<em class="parameter"><code>Deprecated</code></em> for <a class="link" href="rasqal-section-query-results.html#rasqal-new-query-results2" title="rasqal_new_query_results2 ()"><code class="function">rasqal_new_query_results2()</code></a> that loses the unused argument. |
| 141 |
</p> |
| 142 |
<p> |
| 143 |
The <em class="parameter"><code>query</code></em> may be NULL for result set objects that are standalone |
| 144 |
and not attached to any particular query |
| 145 |
</p> |
| 146 |
<div class="variablelist"><table border="0"> |
| 147 |
<col align="left" valign="top"> |
| 148 |
<tbody> |
| 149 |
<tr> |
| 150 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 151 |
<td>rasqal world object</td> |
| 152 |
</tr> |
| 153 |
<tr> |
| 154 |
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td> |
| 155 |
<td>query object (or NULL)</td> |
| 156 |
</tr> |
| 157 |
<tr> |
| 158 |
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> |
| 159 |
<td>query results (expected) type</td> |
| 160 |
</tr> |
| 161 |
<tr> |
| 162 |
<td><p><span class="term"><em class="parameter"><code>vars_table</code></em> :</span></p></td> |
| 163 |
<td>This parameter is *IGNORED*</td> |
| 164 |
</tr> |
| 165 |
<tr> |
| 166 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 167 |
<td>a new query result object or NULL on failure</td> |
| 168 |
</tr> |
| 169 |
</tbody> |
| 170 |
</table></div> |
| 171 |
</div> |
| 172 |
<hr> |
| 173 |
<div class="refsect2"> |
| 174 |
<a name="rasqal-new-query-results2"></a><h3>rasqal_new_query_results2 ()</h3> |
| 175 |
<pre class="programlisting"><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="returnvalue">rasqal_query_results</span></a> * rasqal_new_query_results2 (<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 176 |
<em class="parameter"><code><a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="type">rasqal_query</span></a> *query</code></em>, |
| 177 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>);</pre> |
| 178 |
<p> |
| 179 |
Constructor - create a new query results set |
| 180 |
</p> |
| 181 |
<p> |
| 182 |
The <em class="parameter"><code>query</code></em> may be NULL for result set objects that are standalone |
| 183 |
and not attached to any particular query |
| 184 |
</p> |
| 185 |
<div class="variablelist"><table border="0"> |
| 186 |
<col align="left" valign="top"> |
| 187 |
<tbody> |
| 188 |
<tr> |
| 189 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 190 |
<td>rasqal world object</td> |
| 191 |
</tr> |
| 192 |
<tr> |
| 193 |
<td><p><span class="term"><em class="parameter"><code>query</code></em> :</span></p></td> |
| 194 |
<td>query object (or NULL)</td> |
| 195 |
</tr> |
| 196 |
<tr> |
| 197 |
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> |
| 198 |
<td>query results (expected) type</td> |
| 199 |
</tr> |
| 200 |
<tr> |
| 201 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 202 |
<td>a new query result object or NULL on failure</td> |
| 203 |
</tr> |
| 204 |
</tbody> |
| 205 |
</table></div> |
| 206 |
</div> |
| 207 |
<hr> |
| 208 |
<div class="refsect2"> |
| 209 |
<a name="rasqal-new-query-results-from-string"></a><h3>rasqal_new_query_results_from_string ()</h3> |
| 210 |
<pre class="programlisting"><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="returnvalue">rasqal_query_results</span></a> * rasqal_new_query_results_from_string |
| 211 |
(<em class="parameter"><code><a class="link" href="rasqal-section-general.html#rasqal-world" title="rasqal_world"><span class="type">rasqal_world</span></a> *world</code></em>, |
| 212 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>, |
| 213 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>, |
| 214 |
<em class="parameter"><code>const <span class="type">char</span> *string</code></em>, |
| 215 |
<em class="parameter"><code><span class="type">size_t</span> string_len</code></em>);</pre> |
| 216 |
<p> |
| 217 |
Constructor - create a new query results set from a results format string |
| 218 |
</p> |
| 219 |
<div class="variablelist"><table border="0"> |
| 220 |
<col align="left" valign="top"> |
| 221 |
<tbody> |
| 222 |
<tr> |
| 223 |
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td> |
| 224 |
<td>rasqal world object</td> |
| 225 |
</tr> |
| 226 |
<tr> |
| 227 |
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> |
| 228 |
<td>query results (expected) type; typically <a class="link" href="rasqal-section-query-results.html#RASQAL-QUERY-RESULTS-BINDINGS:CAPS"><span class="type">RASQAL_QUERY_RESULTS_BINDINGS</span></a> |
| 229 |
</td> |
| 230 |
</tr> |
| 231 |
<tr> |
| 232 |
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td> |
| 233 |
<td>base URI of query results format (or NULL)</td> |
| 234 |
</tr> |
| 235 |
<tr> |
| 236 |
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td> |
| 237 |
<td>query results string</td> |
| 238 |
</tr> |
| 239 |
<tr> |
| 240 |
<td><p><span class="term"><em class="parameter"><code>string_len</code></em> :</span></p></td> |
| 241 |
<td>length of <em class="parameter"><code>string</code></em> (or 0 to calculate it here)</td> |
| 242 |
</tr> |
| 243 |
<tr> |
| 244 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 245 |
<td>a new query result object or NULL on failure</td> |
| 246 |
</tr> |
| 247 |
</tbody> |
| 248 |
</table></div> |
| 249 |
</div> |
| 250 |
<hr> |
| 251 |
<div class="refsect2"> |
| 252 |
<a name="rasqal-free-query-results"></a><h3>rasqal_free_query_results ()</h3> |
| 253 |
<pre class="programlisting"><span class="returnvalue">void</span> rasqal_free_query_results (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 254 |
<p> |
| 255 |
Destructor - destroy a rasqal_query_results. |
| 256 |
</p> |
| 257 |
<div class="variablelist"><table border="0"> |
| 258 |
<col align="left" valign="top"> |
| 259 |
<tbody><tr> |
| 260 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 261 |
<td> |
| 262 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> object</td> |
| 263 |
</tr></tbody> |
| 264 |
</table></div> |
| 265 |
</div> |
| 266 |
<hr> |
| 267 |
<div class="refsect2"> |
| 268 |
<a name="rasqal-query-results-add-row"></a><h3>rasqal_query_results_add_row ()</h3> |
| 269 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_add_row (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 270 |
<em class="parameter"><code><a class="link" href="rasqal-section-row.html#rasqal-row" title="rasqal_row"><span class="type">rasqal_row</span></a> *row</code></em>);</pre> |
| 271 |
<p> |
| 272 |
Add a query result row to the sequence of result rows |
| 273 |
</p> |
| 274 |
<div class="variablelist"><table border="0"> |
| 275 |
<col align="left" valign="top"> |
| 276 |
<tbody> |
| 277 |
<tr> |
| 278 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 279 |
<td>query results object</td> |
| 280 |
</tr> |
| 281 |
<tr> |
| 282 |
<td><p><span class="term"><em class="parameter"><code>row</code></em> :</span></p></td> |
| 283 |
<td>query result row</td> |
| 284 |
</tr> |
| 285 |
<tr> |
| 286 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 287 |
<td>non-0 on failure</td> |
| 288 |
</tr> |
| 289 |
</tbody> |
| 290 |
</table></div> |
| 291 |
</div> |
| 292 |
<hr> |
| 293 |
<div class="refsect2"> |
| 294 |
<a name="rasqal-query-results-finished"></a><h3>rasqal_query_results_finished ()</h3> |
| 295 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_finished (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 296 |
<p> |
| 297 |
Find out if binding results are exhausted. |
| 298 |
</p> |
| 299 |
<div class="variablelist"><table border="0"> |
| 300 |
<col align="left" valign="top"> |
| 301 |
<tbody> |
| 302 |
<tr> |
| 303 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 304 |
<td> |
| 305 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 306 |
</tr> |
| 307 |
<tr> |
| 308 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 309 |
<td>non-0 if results are finished or query failed</td> |
| 310 |
</tr> |
| 311 |
</tbody> |
| 312 |
</table></div> |
| 313 |
</div> |
| 314 |
<hr> |
| 315 |
<div class="refsect2"> |
| 316 |
<a name="rasqal-query-results-get-binding-name"></a><h3>rasqal_query_results_get_binding_name ()</h3> |
| 317 |
<pre class="programlisting">const unsigned <span class="returnvalue">char</span> * rasqal_query_results_get_binding_name |
| 318 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 319 |
<em class="parameter"><code><span class="type">int</span> offset</code></em>);</pre> |
| 320 |
<p> |
| 321 |
Get binding name for the current result. |
| 322 |
</p> |
| 323 |
<div class="variablelist"><table border="0"> |
| 324 |
<col align="left" valign="top"> |
| 325 |
<tbody> |
| 326 |
<tr> |
| 327 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 328 |
<td> |
| 329 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 330 |
</tr> |
| 331 |
<tr> |
| 332 |
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td> |
| 333 |
<td>offset of binding name into array of known names</td> |
| 334 |
</tr> |
| 335 |
<tr> |
| 336 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 337 |
<td>a pointer to a shared copy of the binding name or NULL on failure</td> |
| 338 |
</tr> |
| 339 |
</tbody> |
| 340 |
</table></div> |
| 341 |
</div> |
| 342 |
<hr> |
| 343 |
<div class="refsect2"> |
| 344 |
<a name="rasqal-query-results-get-binding-value"></a><h3>rasqal_query_results_get_binding_value ()</h3> |
| 345 |
<pre class="programlisting"><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="returnvalue">rasqal_literal</span></a> * rasqal_query_results_get_binding_value |
| 346 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 347 |
<em class="parameter"><code><span class="type">int</span> offset</code></em>);</pre> |
| 348 |
<p> |
| 349 |
Get one binding value for the current result. |
| 350 |
</p> |
| 351 |
<div class="variablelist"><table border="0"> |
| 352 |
<col align="left" valign="top"> |
| 353 |
<tbody> |
| 354 |
<tr> |
| 355 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 356 |
<td> |
| 357 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 358 |
</tr> |
| 359 |
<tr> |
| 360 |
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td> |
| 361 |
<td>offset of binding name into array of known names</td> |
| 362 |
</tr> |
| 363 |
<tr> |
| 364 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 365 |
<td>a pointer to a shared <a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> binding value or NULL on failure</td> |
| 366 |
</tr> |
| 367 |
</tbody> |
| 368 |
</table></div> |
| 369 |
</div> |
| 370 |
<hr> |
| 371 |
<div class="refsect2"> |
| 372 |
<a name="rasqal-query-results-get-binding-value-by-name"></a><h3>rasqal_query_results_get_binding_value_by_name ()</h3> |
| 373 |
<pre class="programlisting"><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="returnvalue">rasqal_literal</span></a> * rasqal_query_results_get_binding_value_by_name |
| 374 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 375 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> |
| 376 |
<p> |
| 377 |
Get one binding value for a given name in the current result. |
| 378 |
</p> |
| 379 |
<div class="variablelist"><table border="0"> |
| 380 |
<col align="left" valign="top"> |
| 381 |
<tbody> |
| 382 |
<tr> |
| 383 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 384 |
<td> |
| 385 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 386 |
</tr> |
| 387 |
<tr> |
| 388 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 389 |
<td>variable name</td> |
| 390 |
</tr> |
| 391 |
<tr> |
| 392 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 393 |
<td>a pointer to a shared <a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> binding value or NULL on failure</td> |
| 394 |
</tr> |
| 395 |
</tbody> |
| 396 |
</table></div> |
| 397 |
</div> |
| 398 |
<hr> |
| 399 |
<div class="refsect2"> |
| 400 |
<a name="rasqal-query-results-get-bindings"></a><h3>rasqal_query_results_get_bindings ()</h3> |
| 401 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_get_bindings (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 402 |
<em class="parameter"><code>const unsigned <span class="type">char</span> ***names</code></em>, |
| 403 |
<em class="parameter"><code><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> ***values</code></em>);</pre> |
| 404 |
<p> |
| 405 |
Get all binding names, values for current result. |
| 406 |
</p> |
| 407 |
<p> |
| 408 |
If names is not NULL, it is set to the address of a shared array |
| 409 |
of names of the bindings (an output parameter). These names |
| 410 |
are shared and must not be freed by the caller |
| 411 |
</p> |
| 412 |
<p> |
| 413 |
If values is not NULL, it is set to the address of a shared array |
| 414 |
of <a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a>* binding values. These values are shaerd |
| 415 |
and must not be freed by the caller. |
| 416 |
</p> |
| 417 |
<div class="variablelist"><table border="0"> |
| 418 |
<col align="left" valign="top"> |
| 419 |
<tbody> |
| 420 |
<tr> |
| 421 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 422 |
<td> |
| 423 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 424 |
</tr> |
| 425 |
<tr> |
| 426 |
<td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td> |
| 427 |
<td>pointer to an array of binding names (or NULL)</td> |
| 428 |
</tr> |
| 429 |
<tr> |
| 430 |
<td><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td> |
| 431 |
<td>pointer to an array of binding value <a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> (or NULL)</td> |
| 432 |
</tr> |
| 433 |
<tr> |
| 434 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 435 |
<td>non-0 if the assignment failed</td> |
| 436 |
</tr> |
| 437 |
</tbody> |
| 438 |
</table></div> |
| 439 |
</div> |
| 440 |
<hr> |
| 441 |
<div class="refsect2"> |
| 442 |
<a name="rasqal-query-results-get-bindings-count"></a><h3>rasqal_query_results_get_bindings_count ()</h3> |
| 443 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_get_bindings_count |
| 444 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 445 |
<p> |
| 446 |
Get the number of bound variables in the result. |
| 447 |
</p> |
| 448 |
<div class="variablelist"><table border="0"> |
| 449 |
<col align="left" valign="top"> |
| 450 |
<tbody> |
| 451 |
<tr> |
| 452 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 453 |
<td> |
| 454 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 455 |
</tr> |
| 456 |
<tr> |
| 457 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 458 |
<td><0 if failed or results exhausted</td> |
| 459 |
</tr> |
| 460 |
</tbody> |
| 461 |
</table></div> |
| 462 |
</div> |
| 463 |
<hr> |
| 464 |
<div class="refsect2"> |
| 465 |
<a name="rasqal-query-results-get-boolean"></a><h3>rasqal_query_results_get_boolean ()</h3> |
| 466 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_get_boolean (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 467 |
<p> |
| 468 |
Get boolean query result. |
| 469 |
</p> |
| 470 |
<p> |
| 471 |
The return value is only meaningful if this is a boolean |
| 472 |
query result - see <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-is-boolean" title="rasqal_query_results_is_boolean ()"><code class="function">rasqal_query_results_is_boolean()</code></a> |
| 473 |
</p> |
| 474 |
<div class="variablelist"><table border="0"> |
| 475 |
<col align="left" valign="top"> |
| 476 |
<tbody> |
| 477 |
<tr> |
| 478 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 479 |
<td> |
| 480 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 481 |
</tr> |
| 482 |
<tr> |
| 483 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 484 |
<td>boolean query result - >0 is true, 0 is false, <0 on error</td> |
| 485 |
</tr> |
| 486 |
</tbody> |
| 487 |
</table></div> |
| 488 |
</div> |
| 489 |
<hr> |
| 490 |
<div class="refsect2"> |
| 491 |
<a name="rasqal-query-results-get-count"></a><h3>rasqal_query_results_get_count ()</h3> |
| 492 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_get_count (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 493 |
<p> |
| 494 |
Get number of bindings so far. |
| 495 |
</p> |
| 496 |
<div class="variablelist"><table border="0"> |
| 497 |
<col align="left" valign="top"> |
| 498 |
<tbody> |
| 499 |
<tr> |
| 500 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 501 |
<td> |
| 502 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 503 |
</tr> |
| 504 |
<tr> |
| 505 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 506 |
<td>number of bindings found so far or < 0 on failure</td> |
| 507 |
</tr> |
| 508 |
</tbody> |
| 509 |
</table></div> |
| 510 |
</div> |
| 511 |
<hr> |
| 512 |
<div class="refsect2"> |
| 513 |
<a name="rasqal-query-results-get-query"></a><h3>rasqal_query_results_get_query ()</h3> |
| 514 |
<pre class="programlisting"><a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="returnvalue">rasqal_query</span></a> * rasqal_query_results_get_query (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 515 |
<p> |
| 516 |
Get thq query associated with this query result |
| 517 |
</p> |
| 518 |
<div class="variablelist"><table border="0"> |
| 519 |
<col align="left" valign="top"> |
| 520 |
<tbody> |
| 521 |
<tr> |
| 522 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 523 |
<td> |
| 524 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> object</td> |
| 525 |
</tr> |
| 526 |
<tr> |
| 527 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 528 |
<td>shared pointer to query object</td> |
| 529 |
</tr> |
| 530 |
</tbody> |
| 531 |
</table></div> |
| 532 |
</div> |
| 533 |
<hr> |
| 534 |
<div class="refsect2"> |
| 535 |
<a name="rasqal-query-results-get-triple"></a><h3>rasqal_query_results_get_triple ()</h3> |
| 536 |
<pre class="programlisting"><span class="returnvalue">raptor_statement</span> * rasqal_query_results_get_triple (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 537 |
<p> |
| 538 |
Get the current triple in the result. |
| 539 |
</p> |
| 540 |
<p> |
| 541 |
The return value is a shared <span class="type">raptor_statement</span>. |
| 542 |
</p> |
| 543 |
<div class="variablelist"><table border="0"> |
| 544 |
<col align="left" valign="top"> |
| 545 |
<tbody> |
| 546 |
<tr> |
| 547 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 548 |
<td> |
| 549 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 550 |
</tr> |
| 551 |
<tr> |
| 552 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 553 |
<td> |
| 554 |
<span class="type">raptor_statement</span> or NULL if failed or results exhausted</td> |
| 555 |
</tr> |
| 556 |
</tbody> |
| 557 |
</table></div> |
| 558 |
</div> |
| 559 |
<hr> |
| 560 |
<div class="refsect2"> |
| 561 |
<a name="rasqal-query-results-get-row-by-offset"></a><h3>rasqal_query_results_get_row_by_offset ()</h3> |
| 562 |
<pre class="programlisting"><a class="link" href="rasqal-section-row.html#rasqal-row" title="rasqal_row"><span class="returnvalue">rasqal_row</span></a> * rasqal_query_results_get_row_by_offset |
| 563 |
(<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>, |
| 564 |
<em class="parameter"><code><span class="type">int</span> result_offset</code></em>);</pre> |
| 565 |
<p> |
| 566 |
Get stored result row by an offset |
| 567 |
</p> |
| 568 |
<p> |
| 569 |
The result_offset index is 0-indexed into the subset of results |
| 570 |
constrained by any query limit and offset. |
| 571 |
</p> |
| 572 |
<div class="variablelist"><table border="0"> |
| 573 |
<col align="left" valign="top"> |
| 574 |
<tbody> |
| 575 |
<tr> |
| 576 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 577 |
<td>query result</td> |
| 578 |
</tr> |
| 579 |
<tr> |
| 580 |
<td><p><span class="term"><em class="parameter"><code>result_offset</code></em> :</span></p></td> |
| 581 |
<td>index into result rows</td> |
| 582 |
</tr> |
| 583 |
<tr> |
| 584 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 585 |
<td>row or NULL if <em class="parameter"><code>result_offset</code></em> is out of range</td> |
| 586 |
</tr> |
| 587 |
</tbody> |
| 588 |
</table></div> |
| 589 |
</div> |
| 590 |
<hr> |
| 591 |
<div class="refsect2"> |
| 592 |
<a name="rasqal-query-results-get-type"></a><h3>rasqal_query_results_get_type ()</h3> |
| 593 |
<pre class="programlisting"><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="returnvalue">rasqal_query_results_type</span></a> rasqal_query_results_get_type (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 594 |
<p> |
| 595 |
Get query results type |
| 596 |
</p> |
| 597 |
<div class="variablelist"><table border="0"> |
| 598 |
<col align="left" valign="top"> |
| 599 |
<tbody> |
| 600 |
<tr> |
| 601 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 602 |
<td> |
| 603 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> object</td> |
| 604 |
</tr> |
| 605 |
<tr> |
| 606 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 607 |
<td>non-0 if true</td> |
| 608 |
</tr> |
| 609 |
</tbody> |
| 610 |
</table></div> |
| 611 |
</div> |
| 612 |
<hr> |
| 613 |
<div class="refsect2"> |
| 614 |
<a name="rasqal-query-results-is-bindings"></a><h3>rasqal_query_results_is_bindings ()</h3> |
| 615 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_is_bindings (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 616 |
<p> |
| 617 |
Test if rasqal_query_results is variable bindings format. |
| 618 |
</p> |
| 619 |
<div class="variablelist"><table border="0"> |
| 620 |
<col align="left" valign="top"> |
| 621 |
<tbody> |
| 622 |
<tr> |
| 623 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 624 |
<td> |
| 625 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> object</td> |
| 626 |
</tr> |
| 627 |
<tr> |
| 628 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 629 |
<td>non-0 if true</td> |
| 630 |
</tr> |
| 631 |
</tbody> |
| 632 |
</table></div> |
| 633 |
</div> |
| 634 |
<hr> |
| 635 |
<div class="refsect2"> |
| 636 |
<a name="rasqal-query-results-is-boolean"></a><h3>rasqal_query_results_is_boolean ()</h3> |
| 637 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_is_boolean (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 638 |
<p> |
| 639 |
Test if rasqal_query_results is boolean format. |
| 640 |
</p> |
| 641 |
<div class="variablelist"><table border="0"> |
| 642 |
<col align="left" valign="top"> |
| 643 |
<tbody> |
| 644 |
<tr> |
| 645 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 646 |
<td> |
| 647 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> object</td> |
| 648 |
</tr> |
| 649 |
<tr> |
| 650 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 651 |
<td>non-0 if true</td> |
| 652 |
</tr> |
| 653 |
</tbody> |
| 654 |
</table></div> |
| 655 |
</div> |
| 656 |
<hr> |
| 657 |
<div class="refsect2"> |
| 658 |
<a name="rasqal-query-results-is-graph"></a><h3>rasqal_query_results_is_graph ()</h3> |
| 659 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_is_graph (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 660 |
<p> |
| 661 |
Test if rasqal_query_results is RDF graph format. |
| 662 |
</p> |
| 663 |
<div class="variablelist"><table border="0"> |
| 664 |
<col align="left" valign="top"> |
| 665 |
<tbody> |
| 666 |
<tr> |
| 667 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 668 |
<td> |
| 669 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> object</td> |
| 670 |
</tr> |
| 671 |
<tr> |
| 672 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 673 |
<td>non-0 if true</td> |
| 674 |
</tr> |
| 675 |
</tbody> |
| 676 |
</table></div> |
| 677 |
</div> |
| 678 |
<hr> |
| 679 |
<div class="refsect2"> |
| 680 |
<a name="rasqal-query-results-is-syntax"></a><h3>rasqal_query_results_is_syntax ()</h3> |
| 681 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_is_syntax (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 682 |
<p> |
| 683 |
Test if the rasqal_query_results is a syntax. |
| 684 |
</p> |
| 685 |
<p> |
| 686 |
Many of the query results may be formatted as a syntax using the |
| 687 |
<span class="type">rasqal_query_formatter</span> class however this function returns true |
| 688 |
if a syntax result was specifically requested. |
| 689 |
</p> |
| 690 |
<div class="variablelist"><table border="0"> |
| 691 |
<col align="left" valign="top"> |
| 692 |
<tbody> |
| 693 |
<tr> |
| 694 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 695 |
<td> |
| 696 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> object</td> |
| 697 |
</tr> |
| 698 |
<tr> |
| 699 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 700 |
<td>non-0 if true</td> |
| 701 |
</tr> |
| 702 |
</tbody> |
| 703 |
</table></div> |
| 704 |
</div> |
| 705 |
<hr> |
| 706 |
<div class="refsect2"> |
| 707 |
<a name="rasqal-query-results-next"></a><h3>rasqal_query_results_next ()</h3> |
| 708 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_next (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 709 |
<p> |
| 710 |
Move to the next result. |
| 711 |
</p> |
| 712 |
<div class="variablelist"><table border="0"> |
| 713 |
<col align="left" valign="top"> |
| 714 |
<tbody> |
| 715 |
<tr> |
| 716 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 717 |
<td> |
| 718 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 719 |
</tr> |
| 720 |
<tr> |
| 721 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 722 |
<td>non-0 if failed or results exhausted</td> |
| 723 |
</tr> |
| 724 |
</tbody> |
| 725 |
</table></div> |
| 726 |
</div> |
| 727 |
<hr> |
| 728 |
<div class="refsect2"> |
| 729 |
<a name="rasqal-query-results-next-triple"></a><h3>rasqal_query_results_next_triple ()</h3> |
| 730 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_next_triple (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 731 |
<p> |
| 732 |
Move to the next triple result. |
| 733 |
</p> |
| 734 |
<div class="variablelist"><table border="0"> |
| 735 |
<col align="left" valign="top"> |
| 736 |
<tbody> |
| 737 |
<tr> |
| 738 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 739 |
<td> |
| 740 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 741 |
</tr> |
| 742 |
<tr> |
| 743 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 744 |
<td>non-0 if failed or results exhausted</td> |
| 745 |
</tr> |
| 746 |
</tbody> |
| 747 |
</table></div> |
| 748 |
</div> |
| 749 |
<hr> |
| 750 |
<div class="refsect2"> |
| 751 |
<a name="rasqal-query-results-read"></a><h3>rasqal_query_results_read ()</h3> |
| 752 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_read (<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 753 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 754 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 755 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 756 |
<em class="parameter"><code><span class="type">raptor_uri</span> *format_uri</code></em>, |
| 757 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>);</pre> |
| 758 |
<p> |
| 759 |
Read the query results from an iostream in a format. |
| 760 |
</p> |
| 761 |
<p> |
| 762 |
This uses the <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> class |
| 763 |
and the <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter-read" title="rasqal_query_results_formatter_read ()"><code class="function">rasqal_query_results_formatter_read()</code></a> method |
| 764 |
to perform the formatting. |
| 765 |
</p> |
| 766 |
<p> |
| 767 |
See <a class="link" href="rasqal-section-general.html#rasqal-world-get-query-results-format-description" title="rasqal_world_get_query_results_format_description ()"><code class="function">rasqal_world_get_query_results_format_description()</code></a> for |
| 768 |
obtaining the supported format URIs at run time. |
| 769 |
</p> |
| 770 |
<div class="variablelist"><table border="0"> |
| 771 |
<col align="left" valign="top"> |
| 772 |
<tbody> |
| 773 |
<tr> |
| 774 |
<td><p><span class="term"><em class="parameter"><code>iostr</code></em> :</span></p></td> |
| 775 |
<td> |
| 776 |
<span class="type">raptor_iostream</span> to read the query from</td> |
| 777 |
</tr> |
| 778 |
<tr> |
| 779 |
<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td> |
| 780 |
<td> |
| 781 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query results format</td> |
| 782 |
</tr> |
| 783 |
<tr> |
| 784 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 785 |
<td>format name (or NULL)</td> |
| 786 |
</tr> |
| 787 |
<tr> |
| 788 |
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> |
| 789 |
<td>format mime type (or NULL)</td> |
| 790 |
</tr> |
| 791 |
<tr> |
| 792 |
<td><p><span class="term"><em class="parameter"><code>format_uri</code></em> :</span></p></td> |
| 793 |
<td> |
| 794 |
<span class="type">raptor_uri</span> describing the format to read (or NULL for default)</td> |
| 795 |
</tr> |
| 796 |
<tr> |
| 797 |
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td> |
| 798 |
<td> |
| 799 |
<span class="type">raptor_uri</span> base URI of the input format</td> |
| 800 |
</tr> |
| 801 |
<tr> |
| 802 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 803 |
<td>non-0 on failure</td> |
| 804 |
</tr> |
| 805 |
</tbody> |
| 806 |
</table></div> |
| 807 |
</div> |
| 808 |
<hr> |
| 809 |
<div class="refsect2"> |
| 810 |
<a name="rasqal-query-results-write"></a><h3>rasqal_query_results_write ()</h3> |
| 811 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_write (<em class="parameter"><code><span class="type">raptor_iostream</span> *iostr</code></em>, |
| 812 |
<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *results</code></em>, |
| 813 |
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, |
| 814 |
<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>, |
| 815 |
<em class="parameter"><code><span class="type">raptor_uri</span> *format_uri</code></em>, |
| 816 |
<em class="parameter"><code><span class="type">raptor_uri</span> *base_uri</code></em>);</pre> |
| 817 |
<p> |
| 818 |
Write the query results to an iostream in a format. |
| 819 |
</p> |
| 820 |
<p> |
| 821 |
This uses the <a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter" title="rasqal_query_results_formatter"><span class="type">rasqal_query_results_formatter</span></a> class and the |
| 822 |
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formatter-write" title="rasqal_query_results_formatter_write ()"><code class="function">rasqal_query_results_formatter_write()</code></a> method to perform the |
| 823 |
formatting. |
| 824 |
</p> |
| 825 |
<p> |
| 826 |
Note that after calling this method, the query results will be |
| 827 |
empty and <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-finished" title="rasqal_query_results_finished ()"><code class="function">rasqal_query_results_finished()</code></a> will return true (non-0) |
| 828 |
</p> |
| 829 |
<p> |
| 830 |
See <a class="link" href="rasqal-section-general.html#rasqal-world-get-query-results-format-description" title="rasqal_world_get_query_results_format_description ()"><code class="function">rasqal_world_get_query_results_format_description()</code></a> for obtaining the |
| 831 |
supported format names, mime_types and URIs at run time. |
| 832 |
</p> |
| 833 |
<div class="variablelist"><table border="0"> |
| 834 |
<col align="left" valign="top"> |
| 835 |
<tbody> |
| 836 |
<tr> |
| 837 |
<td><p><span class="term"><em class="parameter"><code>iostr</code></em> :</span></p></td> |
| 838 |
<td> |
| 839 |
<span class="type">raptor_iostream</span> to write the query to</td> |
| 840 |
</tr> |
| 841 |
<tr> |
| 842 |
<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td> |
| 843 |
<td> |
| 844 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query results format</td> |
| 845 |
</tr> |
| 846 |
<tr> |
| 847 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 848 |
<td>format name (or NULL)</td> |
| 849 |
</tr> |
| 850 |
<tr> |
| 851 |
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> |
| 852 |
<td>format mime type (or NULL)</td> |
| 853 |
</tr> |
| 854 |
<tr> |
| 855 |
<td><p><span class="term"><em class="parameter"><code>format_uri</code></em> :</span></p></td> |
| 856 |
<td> |
| 857 |
<span class="type">raptor_uri</span> describing the format to write (or NULL for default)</td> |
| 858 |
</tr> |
| 859 |
<tr> |
| 860 |
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td> |
| 861 |
<td> |
| 862 |
<span class="type">raptor_uri</span> base URI of the output format</td> |
| 863 |
</tr> |
| 864 |
<tr> |
| 865 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 866 |
<td>non-0 on failure</td> |
| 867 |
</tr> |
| 868 |
</tbody> |
| 869 |
</table></div> |
| 870 |
</div> |
| 871 |
<hr> |
| 872 |
<div class="refsect2"> |
| 873 |
<a name="rasqal-query-results-type"></a><h3>enum rasqal_query_results_type</h3> |
| 874 |
<pre class="programlisting">typedef enum { |
| 875 |
RASQAL_QUERY_RESULTS_BINDINGS, |
| 876 |
RASQAL_QUERY_RESULTS_BOOLEAN, |
| 877 |
RASQAL_QUERY_RESULTS_GRAPH, |
| 878 |
RASQAL_QUERY_RESULTS_SYNTAX, |
| 879 |
RASQAL_QUERY_RESULTS_UNKNOWN, |
| 880 |
RASQAL_QUERY_RESULTS_LAST = RASQAL_QUERY_RESULTS_UNKNOWN |
| 881 |
} rasqal_query_results_type; |
| 882 |
</pre> |
| 883 |
<p> |
| 884 |
Query result type. |
| 885 |
</p> |
| 886 |
<div class="variablelist"><table border="0"> |
| 887 |
<col align="left" valign="top"> |
| 888 |
<tbody> |
| 889 |
<tr> |
| 890 |
<td><p><a name="RASQAL-QUERY-RESULTS-BINDINGS:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_BINDINGS</code></span></p></td> |
| 891 |
<td>variable binding |
| 892 |
</td> |
| 893 |
</tr> |
| 894 |
<tr> |
| 895 |
<td><p><a name="RASQAL-QUERY-RESULTS-BOOLEAN:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_BOOLEAN</code></span></p></td> |
| 896 |
<td>a single boolean |
| 897 |
</td> |
| 898 |
</tr> |
| 899 |
<tr> |
| 900 |
<td><p><a name="RASQAL-QUERY-RESULTS-GRAPH:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_GRAPH</code></span></p></td> |
| 901 |
<td>an RDF graph |
| 902 |
</td> |
| 903 |
</tr> |
| 904 |
<tr> |
| 905 |
<td><p><a name="RASQAL-QUERY-RESULTS-SYNTAX:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_SYNTAX</code></span></p></td> |
| 906 |
<td>a syntax |
| 907 |
</td> |
| 908 |
</tr> |
| 909 |
<tr> |
| 910 |
<td><p><a name="RASQAL-QUERY-RESULTS-UNKNOWN:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_UNKNOWN</code></span></p></td> |
| 911 |
<td>unknown type |
| 912 |
</td> |
| 913 |
</tr> |
| 914 |
<tr> |
| 915 |
<td><p><a name="RASQAL-QUERY-RESULTS-LAST:CAPS"></a><span class="term"><code class="literal">RASQAL_QUERY_RESULTS_LAST</code></span></p></td> |
| 916 |
<td>internal |
| 917 |
</td> |
| 918 |
</tr> |
| 919 |
</tbody> |
| 920 |
</table></div> |
| 921 |
</div> |
| 922 |
<hr> |
| 923 |
<div class="refsect2"> |
| 924 |
<a name="rasqal-query-results-type-label"></a><h3>rasqal_query_results_type_label ()</h3> |
| 925 |
<pre class="programlisting">const <span class="returnvalue">char</span> * rasqal_query_results_type_label (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</code></em>);</pre> |
| 926 |
<p> |
| 927 |
Get a label for a query results type |
| 928 |
</p> |
| 929 |
<div class="variablelist"><table border="0"> |
| 930 |
<col align="left" valign="top"> |
| 931 |
<tbody> |
| 932 |
<tr> |
| 933 |
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> |
| 934 |
<td> |
| 935 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results-type" title="enum rasqal_query_results_type"><span class="type">rasqal_query_results_type</span></a> type</td> |
| 936 |
</tr> |
| 937 |
<tr> |
| 938 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 939 |
<td>label or NULL on failure (invalid type)</td> |
| 940 |
</tr> |
| 941 |
</tbody> |
| 942 |
</table></div> |
| 943 |
</div> |
| 944 |
<hr> |
| 945 |
<div class="refsect2"> |
| 946 |
<a name="rasqal-query-results-rewind"></a><h3>rasqal_query_results_rewind ()</h3> |
| 947 |
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_query_results_rewind (<em class="parameter"><code><a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> *query_results</code></em>);</pre> |
| 948 |
<p> |
| 949 |
Rewind stored query results to start |
| 950 |
</p> |
| 951 |
<p> |
| 952 |
This requires <a class="link" href="rasqal-section-query.html#rasqal-query-set-store-results" title="rasqal_query_set_store_results ()"><code class="function">rasqal_query_set_store_results()</code></a> to be called before |
| 953 |
query execution. |
| 954 |
</p> |
| 955 |
<div class="variablelist"><table border="0"> |
| 956 |
<col align="left" valign="top"> |
| 957 |
<tbody> |
| 958 |
<tr> |
| 959 |
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td> |
| 960 |
<td> |
| 961 |
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results"><span class="type">rasqal_query_results</span></a> query_results</td> |
| 962 |
</tr> |
| 963 |
<tr> |
| 964 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 965 |
<td>non-0 if rewinding is not available when results are not stored</td> |
| 966 |
</tr> |
| 967 |
</tbody> |
| 968 |
</table></div> |
| 969 |
</div> |
| 970 |
</div> |
| 971 |
</div> |
| 972 |
<div class="footer"> |
| 973 |
<hr> |
| 974 |
Generated by GTK-Doc V1.18</div> |
| 975 |
</body> |
| 976 |
</html> |