1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-06-22 23:30:07 +02:00
audacity/lib-src/redland/rasqal/docs/html/rasqal-section-query-results.html
2010-01-24 09:19:39 +00:00

706 lines
37 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Query Results</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Rasqal RDF Query Library Manual">
<link rel="up" href="pt01.html" title="Part I. Reference Manual">
<link rel="prev" href="rasqal-section-query.html" title="Query">
<link rel="next" href="rasqal-section-query-results-formatter.html" title="Query Results Formatter">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="rasqal.html" title="Rasqal Overview">
<link rel="part" href="pt01.html" title="Part I. Reference Manual">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="rasqal-section-query.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pt01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Rasqal RDF Query Library Manual</th>
<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>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#rasqal-section-query-results.synopsis" class="shortcut">Top</a>
 | 
<a href="#rasqal-section-query-results.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="rasqal-section-query-results"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rasqal-section-query-results.top_of_page"></a>Query Results</span></h2>
<p>Query Results — Query results as variable bindings, boolean or RDF graphs.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="rasqal-section-query-results.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
typedef <a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a>;
void <a class="link" href="rasqal-section-query-results.html#rasqal-free-query-results" title="rasqal_free_query_results ()">rasqal_free_query_results</a> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-finished" title="rasqal_query_results_finished ()">rasqal_query_results_finished</a> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
const unsigned char* <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>
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
int offset);
<a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal">rasqal_literal</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>
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
int offset);
<a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal">rasqal_literal</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>
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
unsigned char *name);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
unsigned char ***names,
<a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal">rasqal_literal</a> ***values);
int <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>
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-triples.html#raptor-statement"
>raptor_statement</a>* <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-next" title="rasqal_query_results_next ()">rasqal_query_results_next</a> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <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> (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);
int <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-read" title="rasqal_query_results_read ()">rasqal_query_results_read</a> (<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-iostream.html#raptor-iostream"
>raptor_iostream</a> *iostr,
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *results,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *format_uri,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *base_uri);
int <a class="link" href="rasqal-section-query-results.html#rasqal-query-results-write" title="rasqal_query_results_write ()">rasqal_query_results_write</a> (<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-iostream.html#raptor-iostream"
>raptor_iostream</a> *iostr,
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *results,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *format_uri,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *base_uri);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="rasqal-section-query-results.description"></a><h2>Description</h2>
<p>
A query results object is only ever constructed by the internal
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>.
It provides interface to the multiple types of result supported.
</p>
<p>
There are a large set of methods for returning all or parts of a
variable binding query result including the names, values or
individuals. A boolean result is straightforward to get with
<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
sequence of raptor triples than can be easily passed to the Raptor
library for serializing to a syntax.
</p>
</div>
<div class="refsect1" lang="en">
<a name="rasqal-section-query-results.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="rasqal-query-results"></a><h3>rasqal_query_results</h3>
<pre class="programlisting">rasqal_graph_query_results* query_results;
</pre>
<p>
Rasqal query results class.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-free-query-results"></a><h3>rasqal_free_query_results ()</h3>
<pre class="programlisting">void rasqal_free_query_results (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Destructor - destroy a rasqal_query_results.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-finished"></a><h3>rasqal_query_results_finished ()</h3>
<pre class="programlisting">int rasqal_query_results_finished (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Find out if binding results are exhausted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if results are finished or query failed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-binding-name"></a><h3>rasqal_query_results_get_binding_name ()</h3>
<pre class="programlisting">const unsigned char* rasqal_query_results_get_binding_name
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
int offset);</pre>
<p>
Get binding name for the current result.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td> offset of binding name into array of known names
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to a shared copy of the binding name or NULL on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-binding-value"></a><h3>rasqal_query_results_get_binding_value ()</h3>
<pre class="programlisting"><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal">rasqal_literal</a>* rasqal_query_results_get_binding_value
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
int offset);</pre>
<p>
Get one binding value for the current result.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td> offset of binding name into array of known names
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-binding-value-by-name"></a><h3>rasqal_query_results_get_binding_value_by_name ()</h3>
<pre class="programlisting"><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal">rasqal_literal</a>* rasqal_query_results_get_binding_value_by_name
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
unsigned char *name);</pre>
<p>
Get one binding value for a given name in the current result.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> variable name
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-bindings"></a><h3>rasqal_query_results_get_bindings ()</h3>
<pre class="programlisting">int rasqal_query_results_get_bindings (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results,
unsigned char ***names,
<a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal">rasqal_literal</a> ***values);</pre>
<p>
Get all binding names, values for current result.
</p>
<p>
If names is not NULL, it is set to the address of a shared array
of names of the bindings (an output parameter). These names
are shared and must not be freed by the caller
</p>
<p>
If values is not NULL, it is set to the address of a shared array
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
and must not be freed by the caller.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td>
<td> pointer to an array of binding names (or NULL)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td>
<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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if the assignment failed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-bindings-count"></a><h3>rasqal_query_results_get_bindings_count ()</h3>
<pre class="programlisting">int rasqal_query_results_get_bindings_count
(<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Get the number of bound variables in the result.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> &lt;0 if failed or results exhausted
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-boolean"></a><h3>rasqal_query_results_get_boolean ()</h3>
<pre class="programlisting">int rasqal_query_results_get_boolean (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Get boolean query result.
</p>
<p>
The return value is only meaningful if this is a boolean
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></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> boolean query result - &gt;0 is true, 0 is false, &lt;0 on error
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-count"></a><h3>rasqal_query_results_get_count ()</h3>
<pre class="programlisting">int rasqal_query_results_get_count (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Get number of bindings so far.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> number of bindings found so far or &lt; 0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-get-triple"></a><h3>rasqal_query_results_get_triple ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/raptor/raptor-section-triples.html#raptor-statement"
>raptor_statement</a>* rasqal_query_results_get_triple (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Get the current triple in the result.
</p>
<p>
The return value is a shared <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-triples.html#raptor-statement"
><span class="type">raptor_statement</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-triples.html#raptor-statement"
><span class="type">raptor_statement</span></a> or NULL if failed or results exhausted
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-is-bindings"></a><h3>rasqal_query_results_is_bindings ()</h3>
<pre class="programlisting">int rasqal_query_results_is_bindings (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Test if rasqal_query_results is variable bindings format.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if true
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-is-boolean"></a><h3>rasqal_query_results_is_boolean ()</h3>
<pre class="programlisting">int rasqal_query_results_is_boolean (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Test if rasqal_query_results is boolean format.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if true
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-is-graph"></a><h3>rasqal_query_results_is_graph ()</h3>
<pre class="programlisting">int rasqal_query_results_is_graph (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Test if rasqal_query_results is RDF graph format.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if true
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-is-syntax"></a><h3>rasqal_query_results_is_syntax ()</h3>
<pre class="programlisting">int rasqal_query_results_is_syntax (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Test if the rasqal_query_results is a syntax.
</p>
<p>
Many of the query results may be formatted as a syntax using the
<span class="type">rasqal_query_formatter</span> class however this function returns true
if a syntax result was specifically requested.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if true
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-next"></a><h3>rasqal_query_results_next ()</h3>
<pre class="programlisting">int rasqal_query_results_next (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Move to the next result.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if failed or results exhausted
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-next-triple"></a><h3>rasqal_query_results_next_triple ()</h3>
<pre class="programlisting">int rasqal_query_results_next_triple (<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *query_results);</pre>
<p>
Move to the next triple result.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>query_results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 if failed or results exhausted
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-read"></a><h3>rasqal_query_results_read ()</h3>
<pre class="programlisting">int rasqal_query_results_read (<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-iostream.html#raptor-iostream"
>raptor_iostream</a> *iostr,
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *results,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *format_uri,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *base_uri);</pre>
<p>
Read the query results from an iostream in a format.
</p>
<p>
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 <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
to perform the formatting. See
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formats-enumerate" title="rasqal_query_results_formats_enumerate ()"><code class="function">rasqal_query_results_formats_enumerate()</code></a>
for obtaining the supported format URIs at run time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iostr</code></em> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-iostream.html#raptor-iostream"
><span class="type">raptor_iostream</span></a> to read the query from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format_uri</code></em> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
><span class="type">raptor_uri</span></a> describing the format to read (or NULL for default)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
><span class="type">raptor_uri</span></a> base URI of the input format
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="rasqal-query-results-write"></a><h3>rasqal_query_results_write ()</h3>
<pre class="programlisting">int rasqal_query_results_write (<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-iostream.html#raptor-iostream"
>raptor_iostream</a> *iostr,
<a class="link" href="rasqal-section-query-results.html#rasqal-query-results" title="rasqal_query_results">rasqal_query_results</a> *results,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *format_uri,
<a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
>raptor_uri</a> *base_uri);</pre>
<p>
Write the query results to an iostream in a format.
</p>
<p>
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 <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 formatting. See
<a class="link" href="rasqal-section-query-results-formatter.html#rasqal-query-results-formats-enumerate" title="rasqal_query_results_formats_enumerate ()"><code class="function">rasqal_query_results_formats_enumerate()</code></a>
for obtaining the supported format URIs at run time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iostr</code></em> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-iostream.html#raptor-iostream"
><span class="type">raptor_iostream</span></a> to write the query to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>results</code></em> :</span></p></td>
<td> <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>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format_uri</code></em> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
><span class="type">raptor_uri</span></a> describing the format to write (or NULL for default)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/raptor/raptor-section-uri.html#raptor-uri"
><span class="type">raptor_uri</span></a> base URI of the output format
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> non-0 on failure
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>