← Back to branch summary

~ubuntu-branches/debian/jessie/gnome-shell/jessie

« back to all changes in this revision

Viewing changes to docs/reference/shell/html/shell-shell-util.html

  • Committer: Package Import Robot
  • Author(s): Michael Biebl
  • Date: 2012-05-30 13:19:38 UTC
  • mfrom: (18.1.24 experimental)
  • Revision ID: package-import@ubuntu.com-20120530131938-i3trc1g1p3is2u6x
Tags: 3.4.1-3
Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/shell/html/shell-shell-util.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>shell-util</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Shell Reference Manual">
 
8
<link rel="up" href="ch06.html" title="Integration helpers and utilities">
 
9
<link rel="prev" href="shell-shell-xfixes-cursor.html" title="shell-xfixes-cursor">
 
10
<link rel="next" href="ShellMountOperation.html" title="ShellMountOperation">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="shell-shell-xfixes-cursor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Shell Reference Manual</th>
 
21
<td><a accesskey="n" href="ShellMountOperation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#shell-shell-util.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#shell-shell-util.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="shell-shell-util"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="shell-shell-util.top_of_page"></a>shell-util</span></h2>
 
34
<p>shell-util</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="shell-shell-util.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis"><span class="returnvalue">char</span> *              <a class="link" href="shell-shell-util.html#shell-get-file-contents-utf8-sync" title="shell_get_file_contents_utf8_sync ()">shell_get_file_contents_utf8_sync</a>   (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
 
41
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
42
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-shell-util.html#shell-parse-search-provider" title="shell_parse_search_provider ()">shell_parse_search_provider</a>         (<em class="parameter"><code>const <span class="type">char</span> *data</code></em>,
 
43
                                                         <em class="parameter"><code><span class="type">char</span> **name</code></em>,
 
44
                                                         <em class="parameter"><code><span class="type">char</span> **url</code></em>,
 
45
                                                         <em class="parameter"><code><span class="type">GList</span> **langs</code></em>,
 
46
                                                         <em class="parameter"><code><span class="type">char</span> **icon_data_uri</code></em>,
 
47
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
48
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-shell-util.html#shell-session-is-active-for-systemd" title="shell_session_is_active_for_systemd ()">shell_session_is_active_for_systemd</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
 
49
<span class="returnvalue">void</span>                <a class="link" href="shell-shell-util.html#shell-shader-effect-set-double-uniform" title="shell_shader_effect_set_double_uniform ()">shell_shader_effect_set_double_uniform</a>
 
50
                                                        (<em class="parameter"><code><span class="type">ClutterShaderEffect</span> *effect</code></em>,
 
51
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">gdouble</span> value</code></em>);
 
53
<span class="returnvalue">char</span> *              <a class="link" href="shell-shell-util.html#shell-util-format-date" title="shell_util_format_date ()">shell_util_format_date</a>              (<em class="parameter"><code>const <span class="type">char</span> *format</code></em>,
 
54
                                                         <em class="parameter"><code><span class="type">gint64</span> time_ms</code></em>);
 
55
<span class="returnvalue">GIcon</span> *             <a class="link" href="shell-shell-util.html#shell-util-get-icon-for-uri" title="shell_util_get_icon_for_uri ()">shell_util_get_icon_for_uri</a>         (<em class="parameter"><code>const <span class="type">char</span> *text_uri</code></em>);
 
56
<span class="returnvalue">char</span> *              <a class="link" href="shell-shell-util.html#shell-util-get-label-for-uri" title="shell_util_get_label_for_uri ()">shell_util_get_label_for_uri</a>        (<em class="parameter"><code>const <span class="type">char</span> *text_uri</code></em>);
 
57
<span class="returnvalue">void</span>                <a class="link" href="shell-shell-util.html#shell-util-get-transformed-allocation" title="shell_util_get_transformed_allocation ()">shell_util_get_transformed_allocation</a>
 
58
                                                        (<em class="parameter"><code><span class="type">ClutterActor</span> *actor</code></em>,
 
59
                                                         <em class="parameter"><code><span class="type">ClutterActorBox</span> *box</code></em>);
 
60
<span class="returnvalue">int</span>                 <a class="link" href="shell-shell-util.html#shell-util-get-week-start" title="shell_util_get_week_start ()">shell_util_get_week_start</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
 
61
<span class="returnvalue">char</span> *              <a class="link" href="shell-shell-util.html#shell-util-normalize-and-casefold" title="shell_util_normalize_and_casefold ()">shell_util_normalize_and_casefold</a>   (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
 
62
<span class="returnvalue">void</span>                <a class="link" href="shell-shell-util.html#shell-util-set-hidden-from-pick" title="shell_util_set_hidden_from_pick ()">shell_util_set_hidden_from_pick</a>     (<em class="parameter"><code><span class="type">ClutterActor</span> *actor</code></em>,
 
63
                                                         <em class="parameter"><code><span class="type">gboolean</span> hidden</code></em>);
 
64
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-shell-util.html#shell-util-wifexited" title="shell_util_wifexited ()">shell_util_wifexited</a>                (<em class="parameter"><code><span class="type">int</span> status</code></em>,
 
65
                                                         <em class="parameter"><code><span class="type">int</span> *exit</code></em>);
 
66
<span class="returnvalue">void</span>                <a class="link" href="shell-shell-util.html#shell-write-soup-message-to-stream" title="shell_write_soup_message_to_stream ()">shell_write_soup_message_to_stream</a>  (<em class="parameter"><code><span class="type">GOutputStream</span> *stream</code></em>,
 
67
                                                         <em class="parameter"><code><span class="type">SoupMessage</span> *message</code></em>,
 
68
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
69
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-shell-util.html#shell-write-string-to-stream" title="shell_write_string_to_stream ()">shell_write_string_to_stream</a>        (<em class="parameter"><code><span class="type">GOutputStream</span> *stream</code></em>,
 
70
                                                         <em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 
71
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1">
 
75
<a name="shell-shell-util.description"></a><h2>Description</h2>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="shell-shell-util.details"></a><h2>Details</h2>
 
79
<div class="refsect2">
 
80
<a name="shell-get-file-contents-utf8-sync"></a><h3>shell_get_file_contents_utf8_sync ()</h3>
 
81
<pre class="programlisting"><span class="returnvalue">char</span> *              shell_get_file_contents_utf8_sync   (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
 
82
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
83
<p>
 
84
Synchronously load the contents of a file as a NUL terminated
 
85
string, validating it as UTF-8.  Embedded NUL characters count as
 
86
invalid content.
 
87
</p>
 
88
<div class="variablelist"><table border="0">
 
89
<col align="left" valign="top">
 
90
<tbody>
 
91
<tr>
 
92
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
 
93
<td>UTF-8 encoded filename path</td>
 
94
</tr>
 
95
<tr>
 
96
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
97
<td>a <span class="type">GError</span>
 
98
</td>
 
99
</tr>
 
100
<tr>
 
101
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
102
<td>File contents. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
103
</td>
 
104
</tr>
 
105
</tbody>
 
106
</table></div>
 
107
</div>
 
108
<hr>
 
109
<div class="refsect2">
 
110
<a name="shell-parse-search-provider"></a><h3>shell_parse_search_provider ()</h3>
 
111
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_parse_search_provider         (<em class="parameter"><code>const <span class="type">char</span> *data</code></em>,
 
112
                                                         <em class="parameter"><code><span class="type">char</span> **name</code></em>,
 
113
                                                         <em class="parameter"><code><span class="type">char</span> **url</code></em>,
 
114
                                                         <em class="parameter"><code><span class="type">GList</span> **langs</code></em>,
 
115
                                                         <em class="parameter"><code><span class="type">char</span> **icon_data_uri</code></em>,
 
116
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
117
<div class="variablelist"><table border="0">
 
118
<col align="left" valign="top">
 
119
<tbody>
 
120
<tr>
 
121
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 
122
<td>description of provider</td>
 
123
</tr>
 
124
<tr>
 
125
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
126
<td>location to store a display name. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
127
</td>
 
128
</tr>
 
129
<tr>
 
130
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
 
131
<td>location to store template of url. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
132
</td>
 
133
</tr>
 
134
<tr>
 
135
<td><p><span class="term"><em class="parameter"><code>langs</code></em> :</span></p></td>
 
136
<td>list of supported languages. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
137
</td>
 
138
</tr>
 
139
<tr>
 
140
<td><p><span class="term"><em class="parameter"><code>icon_data_uri</code></em> :</span></p></td>
 
141
<td>location to store uri. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
142
</td>
 
143
</tr>
 
144
<tr>
 
145
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
146
<td>location to store GError</td>
 
147
</tr>
 
148
<tr>
 
149
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
150
<td>
 
151
<code class="literal">TRUE</code> on success</td>
 
152
</tr>
 
153
</tbody>
 
154
</table></div>
 
155
</div>
 
156
<hr>
 
157
<div class="refsect2">
 
158
<a name="shell-session-is-active-for-systemd"></a><h3>shell_session_is_active_for_systemd ()</h3>
 
159
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_session_is_active_for_systemd (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
160
<p>
 
161
Checks whether the session we are running in is currently active,
 
162
i.e. in the foreground and ready for user input.
 
163
</p>
 
164
<div class="variablelist"><table border="0">
 
165
<col align="left" valign="top">
 
166
<tbody><tr>
 
167
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
168
<td>TRUE if session is active</td>
 
169
</tr></tbody>
 
170
</table></div>
 
171
</div>
 
172
<hr>
 
173
<div class="refsect2">
 
174
<a name="shell-shader-effect-set-double-uniform"></a><h3>shell_shader_effect_set_double_uniform ()</h3>
 
175
<pre class="programlisting"><span class="returnvalue">void</span>                shell_shader_effect_set_double_uniform
 
176
                                                        (<em class="parameter"><code><span class="type">ClutterShaderEffect</span> *effect</code></em>,
 
177
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
 
178
                                                         <em class="parameter"><code><span class="type">gdouble</span> value</code></em>);</pre>
 
179
<p>
 
180
Set a double uniform on a ClutterShaderEffect.
 
181
</p>
 
182
<p>
 
183
The problem here is that JavaScript doesn't have more than
 
184
one number type, and gjs tries to automatically guess what
 
185
type we want to set a GValue to. If the number is "1.0" or
 
186
something, it will use an integer, which will cause errors
 
187
in GLSL.
 
188
</p>
 
189
<div class="variablelist"><table border="0">
 
190
<col align="left" valign="top">
 
191
<tbody>
 
192
<tr>
 
193
<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 
194
<td>The <span class="type">ClutterShaderEffect</span>
 
195
</td>
 
196
</tr>
 
197
<tr>
 
198
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
199
<td>The name of the uniform</td>
 
200
</tr>
 
201
<tr>
 
202
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
203
<td>The value to set it to.</td>
 
204
</tr>
 
205
</tbody>
 
206
</table></div>
 
207
</div>
 
208
<hr>
 
209
<div class="refsect2">
 
210
<a name="shell-util-format-date"></a><h3>shell_util_format_date ()</h3>
 
211
<pre class="programlisting"><span class="returnvalue">char</span> *              shell_util_format_date              (<em class="parameter"><code>const <span class="type">char</span> *format</code></em>,
 
212
                                                         <em class="parameter"><code><span class="type">gint64</span> time_ms</code></em>);</pre>
 
213
<p>
 
214
Formats a date for the current locale. This should be
 
215
used instead of the Spidermonkey Date.toLocaleFormat()
 
216
extension because Date.toLocaleFormat() is buggy for
 
217
Unicode format strings:
 
218
https://bugzilla.mozilla.org/show_bug.cgi?id=508783
 
219
</p>
 
220
<div class="variablelist"><table border="0">
 
221
<col align="left" valign="top">
 
222
<tbody>
 
223
<tr>
 
224
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
 
225
<td>a strftime-style string format, as parsed by
 
226
<code class="function">g_date_time_format()</code>
 
227
</td>
 
228
</tr>
 
229
<tr>
 
230
<td><p><span class="term"><em class="parameter"><code>time_ms</code></em> :</span></p></td>
 
231
<td>milliseconds since 1970-01-01 00:00:00 UTC; the
 
232
value returned by Date.getTime()</td>
 
233
</tr>
 
234
<tr>
 
235
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
236
<td>the formatted date. If the date is
 
237
outside of the range of a GDateTime (which contains
 
238
any plausible dates we actually care about), will
 
239
return an empty string.</td>
 
240
</tr>
 
241
</tbody>
 
242
</table></div>
 
243
</div>
 
244
<hr>
 
245
<div class="refsect2">
 
246
<a name="shell-util-get-icon-for-uri"></a><h3>shell_util_get_icon_for_uri ()</h3>
 
247
<pre class="programlisting"><span class="returnvalue">GIcon</span> *             shell_util_get_icon_for_uri         (<em class="parameter"><code>const <span class="type">char</span> *text_uri</code></em>);</pre>
 
248
<p>
 
249
Look up the icon that should be associated with a given URI.  Handles
 
250
various special GNOME-internal cases like x-nautilus-search, etc.
 
251
</p>
 
252
<div class="variablelist"><table border="0">
 
253
<col align="left" valign="top">
 
254
<tbody>
 
255
<tr>
 
256
<td><p><span class="term"><em class="parameter"><code>text_uri</code></em> :</span></p></td>
 
257
<td>A URI</td>
 
258
</tr>
 
259
<tr>
 
260
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
261
<td>A new <span class="type">GIcon</span>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
262
</td>
 
263
</tr>
 
264
</tbody>
 
265
</table></div>
 
266
</div>
 
267
<hr>
 
268
<div class="refsect2">
 
269
<a name="shell-util-get-label-for-uri"></a><h3>shell_util_get_label_for_uri ()</h3>
 
270
<pre class="programlisting"><span class="returnvalue">char</span> *              shell_util_get_label_for_uri        (<em class="parameter"><code>const <span class="type">char</span> *text_uri</code></em>);</pre>
 
271
</div>
 
272
<hr>
 
273
<div class="refsect2">
 
274
<a name="shell-util-get-transformed-allocation"></a><h3>shell_util_get_transformed_allocation ()</h3>
 
275
<pre class="programlisting"><span class="returnvalue">void</span>                shell_util_get_transformed_allocation
 
276
                                                        (<em class="parameter"><code><span class="type">ClutterActor</span> *actor</code></em>,
 
277
                                                         <em class="parameter"><code><span class="type">ClutterActorBox</span> *box</code></em>);</pre>
 
278
<p>
 
279
This function is similar to a combination of <code class="function">clutter_actor_get_transformed_position()</code>,
 
280
and <code class="function">clutter_actor_get_transformed_size()</code>, but unlike
 
281
<code class="function">clutter_actor_get_transformed_size()</code>, it always returns a transform
 
282
of the current allocation, while <code class="function">clutter_actor_get_transformed_size()</code> returns
 
283
bad values (the transform of the requested size) if a relayout has been
 
284
queued.
 
285
</p>
 
286
<p>
 
287
This function is more convenient to use than
 
288
<code class="function">clutter_actor_get_abs_allocation_vertices()</code> if no transformation is in effect
 
289
and also works around limitations in the GJS binding of arrays.
 
290
</p>
 
291
<div class="variablelist"><table border="0">
 
292
<col align="left" valign="top">
 
293
<tbody>
 
294
<tr>
 
295
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 
296
<td>a <span class="type">ClutterActor</span>
 
297
</td>
 
298
</tr>
 
299
<tr>
 
300
<td><p><span class="term"><em class="parameter"><code>box</code></em> :</span></p></td>
 
301
<td>location to store returned box in stage coordinates. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
302
</td>
 
303
</tr>
 
304
</tbody>
 
305
</table></div>
 
306
</div>
 
307
<hr>
 
308
<div class="refsect2">
 
309
<a name="shell-util-get-week-start"></a><h3>shell_util_get_week_start ()</h3>
 
310
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_util_get_week_start           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
311
<p>
 
312
Gets the first week day for the current locale, expressed as a
 
313
number in the range 0..6, representing week days from Sunday to
 
314
Saturday.
 
315
</p>
 
316
<div class="variablelist"><table border="0">
 
317
<col align="left" valign="top">
 
318
<tbody><tr>
 
319
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
320
<td>A number representing the first week day for the current
 
321
locale</td>
 
322
</tr></tbody>
 
323
</table></div>
 
324
</div>
 
325
<hr>
 
326
<div class="refsect2">
 
327
<a name="shell-util-normalize-and-casefold"></a><h3>shell_util_normalize_and_casefold ()</h3>
 
328
<pre class="programlisting"><span class="returnvalue">char</span> *              shell_util_normalize_and_casefold   (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
 
329
</div>
 
330
<hr>
 
331
<div class="refsect2">
 
332
<a name="shell-util-set-hidden-from-pick"></a><h3>shell_util_set_hidden_from_pick ()</h3>
 
333
<pre class="programlisting"><span class="returnvalue">void</span>                shell_util_set_hidden_from_pick     (<em class="parameter"><code><span class="type">ClutterActor</span> *actor</code></em>,
 
334
                                                         <em class="parameter"><code><span class="type">gboolean</span> hidden</code></em>);</pre>
 
335
<p>
 
336
If <em class="parameter"><code>hidden</code></em> is <code class="literal">TRUE</code>, hide <em class="parameter"><code>actor</code></em> from pick even with a mode of
 
337
<code class="literal">CLUTTER_PICK_ALL</code>; if <em class="parameter"><code>hidden</code></em> is <code class="literal">FALSE</code>, unhide <em class="parameter"><code>actor</code></em>.
 
338
</p>
 
339
<div class="variablelist"><table border="0">
 
340
<col align="left" valign="top">
 
341
<tbody>
 
342
<tr>
 
343
<td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
 
344
<td>A <span class="type">ClutterActor</span>
 
345
</td>
 
346
</tr>
 
347
<tr>
 
348
<td><p><span class="term"><em class="parameter"><code>hidden</code></em> :</span></p></td>
 
349
<td>Whether <em class="parameter"><code>actor</code></em> should be hidden from pick</td>
 
350
</tr>
 
351
</tbody>
 
352
</table></div>
 
353
</div>
 
354
<hr>
 
355
<div class="refsect2">
 
356
<a name="shell-util-wifexited"></a><h3>shell_util_wifexited ()</h3>
 
357
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_util_wifexited                (<em class="parameter"><code><span class="type">int</span> status</code></em>,
 
358
                                                         <em class="parameter"><code><span class="type">int</span> *exit</code></em>);</pre>
 
359
<p>
 
360
Implements libc standard WIFEXITED, that cannot be used JS
 
361
code.
 
362
</p>
 
363
<div class="variablelist"><table border="0">
 
364
<col align="left" valign="top">
 
365
<tbody>
 
366
<tr>
 
367
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
 
368
<td>the status returned by <code class="function">wait()</code> or <code class="function">waitpid()</code>
 
369
</td>
 
370
</tr>
 
371
<tr>
 
372
<td><p><span class="term"><em class="parameter"><code>exit</code></em> :</span></p></td>
 
373
<td>the actual exit status of the process. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
374
</td>
 
375
</tr>
 
376
<tr>
 
377
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
378
<td>TRUE if the process exited normally, FALSE otherwise</td>
 
379
</tr>
 
380
</tbody>
 
381
</table></div>
 
382
</div>
 
383
<hr>
 
384
<div class="refsect2">
 
385
<a name="shell-write-soup-message-to-stream"></a><h3>shell_write_soup_message_to_stream ()</h3>
 
386
<pre class="programlisting"><span class="returnvalue">void</span>                shell_write_soup_message_to_stream  (<em class="parameter"><code><span class="type">GOutputStream</span> *stream</code></em>,
 
387
                                                         <em class="parameter"><code><span class="type">SoupMessage</span> *message</code></em>,
 
388
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
389
<p>
 
390
Write a string to a GOutputStream as binary data. This is a
 
391
workaround for the lack of proper binary strings in GJS.
 
392
</p>
 
393
<div class="variablelist"><table border="0">
 
394
<col align="left" valign="top">
 
395
<tbody>
 
396
<tr>
 
397
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 
398
<td>a <span class="type">GOutputStream</span>
 
399
</td>
 
400
</tr>
 
401
<tr>
 
402
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 
403
<td>a <span class="type">SoupMessage</span>
 
404
</td>
 
405
</tr>
 
406
<tr>
 
407
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
408
<td>location to store GError</td>
 
409
</tr>
 
410
</tbody>
 
411
</table></div>
 
412
</div>
 
413
<hr>
 
414
<div class="refsect2">
 
415
<a name="shell-write-string-to-stream"></a><h3>shell_write_string_to_stream ()</h3>
 
416
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_write_string_to_stream        (<em class="parameter"><code><span class="type">GOutputStream</span> *stream</code></em>,
 
417
                                                         <em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 
418
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
419
<p>
 
420
Write a string to a GOutputStream as UTF-8. This is a workaround
 
421
for not having binary buffers in GJS.
 
422
</p>
 
423
<div class="variablelist"><table border="0">
 
424
<col align="left" valign="top">
 
425
<tbody>
 
426
<tr>
 
427
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 
428
<td>a <span class="type">GOutputStream</span>
 
429
</td>
 
430
</tr>
 
431
<tr>
 
432
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 
433
<td>a UTF-8 string to write to <em class="parameter"><code>stream</code></em>
 
434
</td>
 
435
</tr>
 
436
<tr>
 
437
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
438
<td>location to store GError</td>
 
439
</tr>
 
440
<tr>
 
441
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
442
<td>
 
443
<code class="literal">TRUE</code> if write succeeded</td>
 
444
</tr>
 
445
</tbody>
 
446
</table></div>
 
447
</div>
 
448
</div>
 
449
</div>
 
450
<div class="footer">
 
451
<hr>
 
452
          Generated by GTK-Doc V1.18.1</div>
 
453
</body>
 
454
</html>
 
 
b'\\ No newline at end of file'