This file is indexed.

/usr/share/gtk-doc/html/libgda-4.0/libgda-4.0-GdaServerOperation-individual-nodes.html is in libgda-4.0-doc 4.2.8-2build1.

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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaServerOperation: individual nodes</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="ch20.html" title="Data definition (DDL) queries">
<link rel="prev" href="GdaServerOperation.html" title="GdaServerOperation">
<link rel="next" href="libgda-4.0-GdaServerOperation-sequences.html" title="GdaServerOperation: sequences">
<meta name="generator" content="GTK-Doc V1.17 (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="GdaServerOperation.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch20.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">GNOME Data Access 4 manual</th>
<td><a accesskey="n" href="libgda-4.0-GdaServerOperation-sequences.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgda-4.0-GdaServerOperation-individual-nodes.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgda-4.0-GdaServerOperation-individual-nodes.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgda-4.0-GdaServerOperation-individual-nodes"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-4.0-GdaServerOperation-individual-nodes.top_of_page"></a>GdaServerOperation: individual nodes</span></h2>
<p>GdaServerOperation: individual nodes — Getting information about parts (nodes) composing a path</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-4.0-GdaServerOperation-individual-nodes.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNodeType" title="enum GdaServerOperationNodeType">GdaServerOperationNodeType</a>;
enum                <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNodeStatus" title="enum GdaServerOperationNodeStatus">GdaServerOperationNodeStatus</a>;
                    <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNode" title="GdaServerOperationNode">GdaServerOperationNode</a>;
<a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNode" title="GdaServerOperationNode"><span class="returnvalue">GdaServerOperationNode</span></a> * <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#gda-server-operation-get-node-info" title="gda_server_operation_get_node_info ()">gda_server_operation_get_node_info</a>
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path_format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                     <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#gda-server-operation-get-root-nodes" title="gda_server_operation_get_root_nodes ()">gda_server_operation_get_root_nodes</a>
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>);
<a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNodeType" title="enum GdaServerOperationNodeType"><span class="returnvalue">GdaServerOperationNodeType</span></a>  <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#gda-server-operation-get-node-type" title="gda_server_operation_get_node_type ()">gda_server_operation_get_node_type</a>
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNodeStatus" title="enum GdaServerOperationNodeStatus"><span class="type">GdaServerOperationNodeStatus</span></a> *status</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#gda-server-operation-get-node-parent" title="gda_server_operation_get_node_parent ()">gda_server_operation_get_node_parent</a>
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#gda-server-operation-get-node-path-portion" title="gda_server_operation_get_node_path_portion ()">gda_server_operation_get_node_path_portion</a>
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgda-4.0-GdaServerOperation-individual-nodes.description"></a><h2>Description</h2>
<p>
  To each part of a path is associated a node (as a <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNode" title="GdaServerOperationNode"><span class="type">GdaServerOperationNode</span></a> structure). For example the
  "/TABLE_DEF_P/TABLE_NAME" path has two nodes, one associated to "/TABLE_DEF_P" and one to
  "/TABLE_DEF_P/TABLE_NAME". For more information about the path's format, see the
  <a class="link" href="GdaServerOperation.html#gda-server-operation-set-value-at" title="gda_server_operation_set_value_at ()"><code class="function">gda_server_operation_set_value_at()</code></a>'s documentation.
</p>
<p>
  This API is designed to get information about all the nodes present in a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> object (refer to the
  <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#gda-server-operation-get-root-nodes" title="gda_server_operation_get_root_nodes ()"><code class="function">gda_server_operation_get_root_nodes()</code></a> function) and about each node of a path, and allows inspection
  of its contents. It is mainly reserved for database provider's implementations but can have its purpose
  outside of this scope.
</p>
</div>
<div class="refsect1">
<a name="libgda-4.0-GdaServerOperation-individual-nodes.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaServerOperationNodeType"></a><h3>enum GdaServerOperationNodeType</h3>
<pre class="programlisting">typedef enum {
	GDA_SERVER_OPERATION_NODE_PARAMLIST,
	GDA_SERVER_OPERATION_NODE_DATA_MODEL,
	GDA_SERVER_OPERATION_NODE_PARAM,
	GDA_SERVER_OPERATION_NODE_SEQUENCE,
	GDA_SERVER_OPERATION_NODE_SEQUENCE_ITEM,

	GDA_SERVER_OPERATION_NODE_DATA_MODEL_COLUMN,
	GDA_SERVER_OPERATION_NODE_UNKNOWN
} GdaServerOperationNodeType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaServerOperationNodeStatus"></a><h3>enum GdaServerOperationNodeStatus</h3>
<pre class="programlisting">typedef enum {
	GDA_SERVER_OPERATION_STATUS_OPTIONAL,
	GDA_SERVER_OPERATION_STATUS_REQUIRED,
	GDA_SERVER_OPERATION_STATUS_UNKNOWN
} GdaServerOperationNodeStatus;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaServerOperationNode"></a><h3>GdaServerOperationNode</h3>
<pre class="programlisting">typedef struct {
	GdaServerOperationNodeType    type;
	GdaServerOperationNodeStatus  status;
	
	GdaSet                       *plist;
	GdaDataModel                 *model;
	GdaColumn                    *column;
	GdaHolder                    *param; 
	gpointer                      priv;
} GdaServerOperationNode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-server-operation-get-node-info"></a><h3>gda_server_operation_get_node_info ()</h3>
<pre class="programlisting"><a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNode" title="GdaServerOperationNode"><span class="returnvalue">GdaServerOperationNode</span></a> * gda_server_operation_get_node_info
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path_format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
Get information about the node identified by <em class="parameter"><code>path</code></em>. The returned <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNode" title="GdaServerOperationNode"><span class="type">GdaServerOperationNode</span></a> structure can be 
copied but not modified; it may change or cease to exist if <em class="parameter"><code>op</code></em> changes
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
<td>a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path_format</code></em> :</span></p></td>
<td>a complete path to a node (starting with "/") as a format string, similar to <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strdup-printf"><code class="function">g_strdup_printf()</code></a>'s argument</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>the arguments to insert into the format string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNode" title="GdaServerOperationNode"><span class="type">GdaServerOperationNode</span></a> structure, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the node was not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-server-operation-get-root-nodes"></a><h3>gda_server_operation_get_root_nodes ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                     gda_server_operation_get_root_nodes
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>);</pre>
<p>
Get an array of strings containing the paths of nodes situated at the root of <em class="parameter"><code>op</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
<td>a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new array, which must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-server-operation-get-node-type"></a><h3>gda_server_operation_get_node_type ()</h3>
<pre class="programlisting"><a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNodeType" title="enum GdaServerOperationNodeType"><span class="returnvalue">GdaServerOperationNodeType</span></a>  gda_server_operation_get_node_type
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libgda-4.0-GdaServerOperation-individual-nodes.html#GdaServerOperationNodeStatus" title="enum GdaServerOperationNodeStatus"><span class="type">GdaServerOperationNodeStatus</span></a> *status</code></em>);</pre>
<p>
Convenience function to get the type of a node.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
<td>a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>a complete path to a node (starting with "/")</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td>a place to store the status of the node, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the type of node, or GDA_SERVER_OPERATION_NODE_UNKNOWN if the node was not found</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-server-operation-get-node-parent"></a><h3>gda_server_operation_get_node_parent ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gda_server_operation_get_node_parent
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<p>
Get the complete path to the parent of the node defined by <em class="parameter"><code>path</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
<td>a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>a complete path to a node (starting with "/")</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the node does not have any parent or does not exist. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-server-operation-get-node-path-portion"></a><h3>gda_server_operation_get_node_path_portion ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gda_server_operation_get_node_path_portion
                                                        (<em class="parameter"><code><a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> *op</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<p>
Get the last part of <em class="parameter"><code>path</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
<td>a <a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>a complete path to a node (starting with "/")</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libgda-4.0-GdaServerOperation-individual-nodes.see-also"></a><h2>See Also</h2>
<p>
  The <a class="link" href="GdaServerOperation.html" title="GdaServerOperation"><span class="type">GdaServerOperation</span></a> object.
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>