/usr/share/gtk-doc/html/rasqal/rasqal-section-variables-table.html is in librasqal3-doc 0.9.32-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Variables Table</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Rasqal RDF Query Library Manual">
<link rel="up" href="reference-manual.html" title="Part I. Reference Manual">
<link rel="prev" href="rasqal-section-variable.html" title="Variables">
<link rel="next" href="rasqal-section-updates.html" title="Updates">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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-variable.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference-manual.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-updates.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#rasqal-section-variables-table.synopsis" class="shortcut">Top</a>
|
<a href="#rasqal-section-variables-table.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="rasqal-section-variables-table"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rasqal-section-variables-table.top_of_page"></a>Variables Table</span></h2>
<p>Variables Table — A table of variables with optional bound literal values.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="rasqal-section-variables-table.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">typedef <a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table">rasqal_variables_table</a>;
<a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table"><span class="returnvalue">rasqal_variables_table</span></a> * <a class="link" href="rasqal-section-variables-table.html#rasqal-new-variables-table" title="rasqal_new_variables_table ()">rasqal_new_variables_table</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>);
<span class="returnvalue">void</span> <a class="link" href="rasqal-section-variables-table.html#rasqal-free-variables-table" title="rasqal_free_variables_table ()">rasqal_free_variables_table</a> (<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> *vt</code></em>);
<a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="returnvalue">rasqal_variable</span></a> * <a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table-add" title="rasqal_variables_table_add ()">rasqal_variables_table_add</a> (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable-type" title="enum rasqal_variable_type"><span class="type">rasqal_variable_type</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> *value</code></em>);
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table-add-variable" title="rasqal_variables_table_add_variable ()">rasqal_variables_table_add_variable</a> (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="type">rasqal_variable</span></a> *variable</code></em>);
<a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="returnvalue">rasqal_variable</span></a> * <a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table-get-by-name" title="rasqal_variables_table_get_by_name ()">rasqal_variables_table_get_by_name</a> (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable-type" title="enum rasqal_variable_type"><span class="type">rasqal_variable_type</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<span class="returnvalue">int</span> <a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table-contains" title="rasqal_variables_table_contains ()">rasqal_variables_table_contains</a> (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable-type" title="enum rasqal_variable_type"><span class="type">rasqal_variable_type</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="rasqal-section-variables-table.description"></a><h2>Description</h2>
<p>
A table of <a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="type">rasqal_variable</span></a> usually associated with a <a class="link" href="rasqal-section-query.html#rasqal-query" title="rasqal_query"><span class="type">rasqal_query</span></a> query
or <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 result set. The order of the variables in
the table may be significant, such as for a standalone query result set
in which case it might define the order of variables in resulting rows.
</p>
</div>
<div class="refsect1">
<a name="rasqal-section-variables-table.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="rasqal-variables-table"></a><h3>rasqal_variables_table</h3>
<pre class="programlisting">typedef struct rasqal_variables_table_s rasqal_variables_table;
</pre>
<p>
Internal - for now
</p>
</div>
<hr>
<div class="refsect2">
<a name="rasqal-new-variables-table"></a><h3>rasqal_new_variables_table ()</h3>
<pre class="programlisting"><a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table"><span class="returnvalue">rasqal_variables_table</span></a> * rasqal_new_variables_table (<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>);</pre>
<p>
Constructor - create a new variables table
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td>
<td>rasqal world</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>new variables table or NULL On failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rasqal-free-variables-table"></a><h3>rasqal_free_variables_table ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> rasqal_free_variables_table (<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> *vt</code></em>);</pre>
<p>
Destructor - destroy a new variables table
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>vt</code></em> :</span></p></td>
<td>rasqal variables table</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rasqal-variables-table-add"></a><h3>rasqal_variables_table_add ()</h3>
<pre class="programlisting"><a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="returnvalue">rasqal_variable</span></a> * rasqal_variables_table_add (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable-type" title="enum rasqal_variable_type"><span class="type">rasqal_variable_type</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> *value</code></em>);</pre>
<p>
Constructor - Create a new variable and add it to the variables table
</p>
<p>
The <em class="parameter"><code>name</code></em> and <em class="parameter"><code>value</code></em> become owned by the rasqal_variable
structure. If a variable with the name already exists, that is
returned and the new <em class="parameter"><code>value</code></em> is ignored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vt</code></em> :</span></p></td>
<td>
<a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table"><span class="type">rasqal_variables_table</span></a> to associate the variable with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>variable type defined by enumeration rasqal_variable_type</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"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>variable <a class="link" href="rasqal-section-literal.html#rasqal-literal" title="rasqal_literal"><span class="type">rasqal_literal</span></a> value (or NULL)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="type">rasqal_variable</span></a> or NULL on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rasqal-variables-table-add-variable"></a><h3>rasqal_variables_table_add_variable ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_variables_table_add_variable (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="type">rasqal_variable</span></a> *variable</code></em>);</pre>
<p>
Constructor - Add an existing variable to the variables table
</p>
<p>
The variables table <em class="parameter"><code>vt</code></em> takes a reference to <em class="parameter"><code>variable</code></em>. This
function will fail if the variable is already in the table. Use
<a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table-contains" title="rasqal_variables_table_contains ()"><code class="function">rasqal_variables_table_contains()</code></a> to check before calling.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vt</code></em> :</span></p></td>
<td>
<a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table"><span class="type">rasqal_variables_table</span></a> to associate the variable with</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>variable</code></em> :</span></p></td>
<td>existing variable to add</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non-0 on failure (such as name already exists)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rasqal-variables-table-get-by-name"></a><h3>rasqal_variables_table_get_by_name ()</h3>
<pre class="programlisting"><a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="returnvalue">rasqal_variable</span></a> * rasqal_variables_table_get_by_name (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable-type" title="enum rasqal_variable_type"><span class="type">rasqal_variable_type</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Lookup a variable by type and name in the variables table.
</p>
<p>
Note that looking up for any type <a class="link" href="rasqal-section-variable.html#RASQAL-VARIABLE-TYPE-UNKNOWN:CAPS"><span class="type">RASQAL_VARIABLE_TYPE_UNKNOWN</span></a>
may a name match but for any type so in cases where the query has
both a named and anonymous (extensional) variable, an arbitrary one
will be returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vt</code></em> :</span></p></td>
<td>the variables table</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the variable type to match or <a class="link" href="rasqal-section-variable.html#RASQAL-VARIABLE-TYPE-UNKNOWN:CAPS"><span class="type">RASQAL_VARIABLE_TYPE_UNKNOWN</span></a> for any.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the variable type</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a shared pointer to the <a class="link" href="rasqal-section-variable.html#rasqal-variable" title="rasqal_variable"><span class="type">rasqal_variable</span></a> or NULL if not found</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="rasqal-variables-table-contains"></a><h3>rasqal_variables_table_contains ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> rasqal_variables_table_contains (<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> *vt</code></em>,
<em class="parameter"><code><a class="link" href="rasqal-section-variable.html#rasqal-variable-type" title="enum rasqal_variable_type"><span class="type">rasqal_variable_type</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Check if there is a variable with the given type and name in the variables table
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vt</code></em> :</span></p></td>
<td>
<a class="link" href="rasqal-section-variables-table.html#rasqal-variables-table" title="rasqal_variables_table"><span class="type">rasqal_variables_table</span></a> to lookup</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>variable type</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>non-0 if the variable is present</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|