udisks2-doc 2.1.3-1 / usr / share / gtk-doc / html / udisks2 / UDisksSpawnedJob.html

This file is indexed.

/usr/share/gtk-doc/html/udisks2/UDisksSpawnedJob.html is in udisks2-doc 2.1.3-1.

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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UDisks Reference Manual: UDisksSpawnedJob</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ref-daemon-jobs.html" title="Jobs">
<link rel="prev" href="UDisksThreadedJob.html" title="UDisksThreadedJob">
<link rel="next" href="ref-daemon-linux-types.html" title="Linux-specific types">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#UDisksSpawnedJob.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#UDisksSpawnedJob.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 
                  <a href="#UDisksSpawnedJob.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 
                  <a href="#UDisksSpawnedJob.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 
                  <a href="#UDisksSpawnedJob.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ref-daemon-jobs.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="UDisksThreadedJob.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ref-daemon-linux-types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="UDisksSpawnedJob"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="UDisksSpawnedJob.top_of_page"></a>UDisksSpawnedJob</span></h2>
<p>UDisksSpawnedJob — Job that spawns a command</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="UDisksSpawnedJob.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="returnvalue">UDisksSpawnedJob</span></a> *
</td>
<td class="function_name">
<a class="link" href="UDisksSpawnedJob.html#udisks-spawned-job-new" title="udisks_spawned_job_new ()">udisks_spawned_job_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="UDisksSpawnedJob.html#udisks-spawned-job-get-command-line" title="udisks_spawned_job_get_command_line ()">udisks_spawned_job_get_command_line</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="UDisksSpawnedJob.html#UDisksSpawnedJob--command-line" title="The “command-line” property">command-line</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="UDisksSpawnedJob.html#UDisksSpawnedJob--input-string" title="The “input-string” property">input-string</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="UDisksSpawnedJob.html#UDisksSpawnedJob--run-as-euid" title="The “run-as-euid” property">run-as-euid</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="UDisksSpawnedJob.html#UDisksSpawnedJob--run-as-uid" title="The “run-as-uid” property">run-as-uid</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="UDisksSpawnedJob.html#UDisksSpawnedJob-spawned-job-completed" title="The “spawned-job-completed” signal">spawned-job-completed</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="UDisksSpawnedJob.html#UDisksSpawnedJob-struct" title="UDisksSpawnedJob">UDisksSpawnedJob</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GDBusInterfaceSkeleton
        <span class="lineart">╰──</span> <a class="link" href="UDisksJob.html#UDisksJobSkeleton">UDisksJobSkeleton</a>
            <span class="lineart">╰──</span> <a class="link" href="UDisksBaseJob.html" title="UDisksBaseJob">UDisksBaseJob</a>
                <span class="lineart">╰──</span> UDisksSpawnedJob
</pre>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
UDisksSpawnedJob implements
 GDBusInterface and  <a class="link" href="UDisksJob.html" title="UDisksJob">UDisksJob</a>.</p>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.description"></a><h2>Description</h2>
<p>This type provides an implementation of the <a class="link" href="UDisksJob.html" title="UDisksJob"><span class="type">UDisksJob</span></a> interface
for jobs that are implemented by spawning a command line.</p>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="udisks-spawned-job-new"></a><h3>udisks_spawned_job_new ()</h3>
<pre class="programlisting"><a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="returnvalue">UDisksSpawnedJob</span></a> *
udisks_spawned_job_new (<em class="parameter"><code>const <span class="type">gchar</span> *command_line</code></em>,
                        <em class="parameter"><code>const <span class="type">gchar</span> *input_string</code></em>,
                        <em class="parameter"><code><span class="type">uid_t</span> run_as_uid</code></em>,
                        <em class="parameter"><code><span class="type">uid_t</span> run_as_euid</code></em>,
                        <em class="parameter"><code><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *daemon</code></em>,
                        <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre>
<p>Creates a new <a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="type">UDisksSpawnedJob</span></a> instance.</p>
<p>The job is started immediately - connect to the
<a class="link" href="UDisksSpawnedJob.html#UDisksSpawnedJob-spawned-job-completed" title="The “spawned-job-completed” signal"><span class="type">“spawned-job-completed”</span></a> or <a class="link" href="UDisksJob.html#UDisksJob-completed" title="The “completed” signal"><span class="type">“completed”</span></a>
signals to get notified when the job is done.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>command_line</p></td>
<td class="parameter_description"><p>The command line to run.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>input_string</p></td>
<td class="parameter_description"><p>A string to write to stdin of the spawned program or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run_as_uid</p></td>
<td class="parameter_description"><p>The <span class="type">uid_t</span> to run the program as.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>run_as_euid</p></td>
<td class="parameter_description"><p>The effective <span class="type">uid_t</span> to run the program as.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>daemon</p></td>
<td class="parameter_description"><p>A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>A <span class="type">GCancellable</span> or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.10.2.7"></a><h4>Returns</h4>
<p> A new <a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="type">UDisksSpawnedJob</span></a>. Free with <code class="function">g_object_unref()</code>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="udisks-spawned-job-get-command-line"></a><h3>udisks_spawned_job_get_command_line ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
udisks_spawned_job_get_command_line (<em class="parameter"><code><a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="type">UDisksSpawnedJob</span></a> *job</code></em>);</pre>
<p>Gets the command line that <em class="parameter"><code>job</code></em>
 was constructed with.</p>
<div class="refsect3">
<a name="id-1.5.4.5.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>job</p></td>
<td class="parameter_description"><p>A <a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="type">UDisksSpawnedJob</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.10.3.6"></a><h4>Returns</h4>
<p> A string owned by <em class="parameter"><code>job</code></em>
. Do not free.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="UDisksSpawnedJob-struct"></a><h3>UDisksSpawnedJob</h3>
<pre class="programlisting">typedef struct _UDisksSpawnedJob UDisksSpawnedJob;</pre>
<p>The <a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="type">UDisksSpawnedJob</span></a> structure contains only private data and should
only be accessed using the provided API.</p>
</div>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="UDisksSpawnedJob--command-line"></a><h3>The <code class="literal">“command-line”</code> property</h3>
<pre class="programlisting">  “command-line”             <span class="type">gchar</span> *</pre>
<p>The command-line to run.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="UDisksSpawnedJob--input-string"></a><h3>The <code class="literal">“input-string”</code> property</h3>
<pre class="programlisting">  “input-string”             <span class="type">gchar</span> *</pre>
<p>String that will be written to stdin of the spawned program or
<code class="literal">NULL</code> to not write anything.</p>
<p>Flags: Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="UDisksSpawnedJob--run-as-euid"></a><h3>The <code class="literal">“run-as-euid”</code> property</h3>
<pre class="programlisting">  “run-as-euid”              <span class="type">guint</span></pre>
<p>The effective <span class="type">uid_t</span> to run the program as.</p>
<p>Flags: Write / Construct Only</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="UDisksSpawnedJob--run-as-uid"></a><h3>The <code class="literal">“run-as-uid”</code> property</h3>
<pre class="programlisting">  “run-as-uid”               <span class="type">guint</span></pre>
<p>The <span class="type">uid_t</span> to run the program as.</p>
<p>Flags: Write / Construct Only</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="UDisksSpawnedJob.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="UDisksSpawnedJob-spawned-job-completed"></a><h3>The <code class="literal">“spawned-job-completed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="type">UDisksSpawnedJob</span></a> *job,
               <span class="type">GError</span>           *error,
               <span class="type">gint</span>              status,
               <span class="type">GString</span>          *standard_output,
               <span class="type">GString</span>          *standard_error,
               <span class="type">gpointer</span>          user_data)</pre>
<p>Emitted when the spawned job is complete. If spawning the command
failed or if the job was cancelled, <em class="parameter"><code>error</code></em>
 will
non-<code class="literal">NULL</code>. Otherwise you can use macros such as <code class="function">WIFEXITED()</code> and
<code class="function">WEXITSTATUS()</code> on the <em class="parameter"><code>status</code></em>
 integer to obtain more information.</p>
<p>The default implementation simply emits the <a class="link" href="UDisksJob.html#UDisksJob-completed" title="The “completed” signal"><span class="type">“completed”</span></a>
signal with <em class="parameter"><code>success</code></em>
 set to <code class="literal">TRUE</code> if, and only if, <em class="parameter"><code>error</code></em>
 is
<code class="literal">NULL</code>, <code class="function">WIFEXITED()</code> evaluates to <code class="literal">TRUE</code> and <code class="function">WEXITSTATUS()</code> is
zero. Additionally, <em class="parameter"><code>message</code></em>
 on that signal is set to
<em class="parameter"><code>standard_error</code></em>
 regards of whether <em class="parameter"><code>success</code></em>
 is <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</p>
<p>You can avoid the default implementation by returning <code class="literal">TRUE</code> from
your signal handler.</p>
<p>This signal is emitted in the</p>
thread-default main loop<p>of the thread that <em class="parameter"><code>job</code></em>
 was created in.</p>
<div class="refsect3">
<a name="id-1.5.4.5.13.2.10"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>job</p></td>
<td class="parameter_description"><p>The <a class="link" href="UDisksSpawnedJob.html" title="UDisksSpawnedJob"><span class="type">UDisksSpawnedJob</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code> if running the whole command line succeeded, otherwise a <span class="type">GError</span> that is set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>status</p></td>
<td class="parameter_description"><p>The exit status of the command line that was run.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>standard_output</p></td>
<td class="parameter_description"><p>Standard output from the command line that was run.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>standard_error</p></td>
<td class="parameter_description"><p>Standard error output from the command line that was run.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.5.13.2.11"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the signal was handled, <code class="literal">FALSE</code> to let other
handlers run.</p>
<p></p>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.