~ubuntu-branches/ubuntu/feisty/libgnome/feisty
» Revision
18
: doc/reference/html/libgnome-gnome-util.html
« back to all changes in this revision
Viewing changes to doc/reference/html/libgnome-gnome-util.html
- browse files at revision 18
- compare with another revision
- download diff
- download tarball
- view history from revision 18
- Committer: Bazaar Package Importer
- Author(s): Sebastien Bacher
- Date: 2006-11-15 15:52:31 UTC
- mfrom: (1.1.10 upstream)
- Revision ID: james.westby@ubuntu.com-20061115155231-gbp2xt8ns20vf1vh
Tags: 2.17.0-0ubuntu1
* New upstream version:
- Enable a11y by default in devel releases
- Don't check for null before calling g_free/g_strdup
- Improve strings in error messages and other places
- GThread initialization fix
* debian/patches/08_dont_force_a11y_activation.patch:
- don't force a11y activation
* debian/patches/09_run_app_message_fix.patch:
- fixed with the new version
- Enable a11y by default in devel releases
- Don't check for null before calling g_free/g_strdup
- Improve strings in error messages and other places
- GThread initialization fix
* debian/patches/08_dont_force_a11y_activation.patch:
- don't force a11y activation
* debian/patches/09_run_app_message_fix.patch:
- fixed with the new version
- files added:
- debian/patches/08_dont_force_a11y_activation.patch
- files removed:
- debian/patches/09_run_app_message_fix.patch
- files modified:
- ChangeLog
added
removed
doc/reference/html/libgnome-gnome-util.html
5
5
<title>gnome-util</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7
7
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
8
<link rel="up" href="ch01s04.html" title="Miscellaneous">
9
<link rel="prev" href="ch01s04.html" title="Miscellaneous">
8
<link rel="up" href="ch04.html" title="Miscellaneous">
9
<link rel="prev" href="ch04.html" title="Miscellaneous">
10
10
<link rel="next" href="libgnome-gnome-sound.html" title="gnome-sound">
11
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="libgnome.html" title="GNOME Library (libgnome)">
13
<link rel="part" href="libgnome.html" title="Part I. GNOME Library (libgnome)">
14
<link rel="chapter" href="ch01.html" title="Initializing Applications and Starting Programs">
15
<link rel="chapter" href="ch02.html" title="Configuration">
16
<link rel="chapter" href="ch03.html" title="Displaying Help and External Info">
17
<link rel="chapter" href="ch04.html" title="Miscellaneous">
18
<link rel="chapter" href="ch05.html" title="Lower Level Interactions">
19
<link rel="chapter" href="ch06.html" title="Deprecated Modules">
20
<link rel="index" href="ix01.html" title="Index">
21
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
22
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
23
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
24
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
25
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
26
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
27
<link rel="index" href="ix08.html" title="Index of new symbols in 2.12">
28
<link rel="index" href="ix09.html" title="Index of new symbols in 2.14">
29
<link rel="index" href="ix10.html" title="Index of new symbols in 2.16">
14
30
</head>
15
31
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
32
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
33
<tr valign="middle">
18
<td><a accesskey="p" href="ch01s04.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
<td><a accesskey="u" href="ch01s04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
34
<td><a accesskey="p" href="ch04.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
35
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
36
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
22
38
<td><a accesskey="n" href="libgnome-gnome-sound.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
39
</tr>
24
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2822350" class="shortcut">Top</a>
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2990174" class="shortcut">Top</a>
25
41
 | 
26
<a href="#id2822642" class="shortcut">Description</a></nobr></td></tr>
42
<a href="#id2990465" class="shortcut">Description</a></nobr></td></tr>
27
43
</table>
28
44
<div class="refentry" lang="en">
29
45
<a name="libgnome-gnome-util"></a><div class="titlepage"></div>
30
46
<div class="refnamediv"><table width="100%"><tr>
31
47
<td valign="top">
32
48
<h2>
33
<a name="id2822350"></a><span class="refentrytitle">gnome-util</span>
49
<a name="id2990174"></a><span class="refentrytitle">gnome-util</span>
34
50
</h2>
35
51
<p>gnome-util — Miscellaneous utility functions.</p>
36
52
</td>
51
67
int <a href="libgnome-gnome-util.html#gnome-setenv">gnome_setenv</a> (const char *name,
52
68
const char *value,
53
69
<a
54
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
70
href="../glib/glib-Basic-Types.html#gboolean"
55
71
>gboolean</a> overwrite);
56
72
void <a href="libgnome-gnome-util.html#gnome-unsetenv">gnome_unsetenv</a> (const char *name);
57
73
void <a href="libgnome-gnome-util.html#gnome-clearenv">gnome_clearenv</a> (void);
74
90
</pre>
75
91
</div>
76
92
<div class="refsect1" lang="en">
77
<a name="id2822642"></a><h2>Description</h2>
93
<a name="id2990465"></a><h2>Description</h2>
78
94
<p>
79
95
The functions in this section provide some shortcuts to finding certain file
80
96
paths. There are also some functions for manipulating environment variables for
91
107
</div>
92
108
</div>
93
109
<div class="refsect1" lang="en">
94
<a name="id2822684"></a><h2>Details</h2>
110
<a name="id2990507"></a><h2>Details</h2>
95
111
<div class="refsect2" lang="en">
96
<a name="id2822695"></a><h3>
112
<a name="id2990517"></a><h3>
97
113
<a name="gnome-is-program-in-path"></a>gnome_is_program_in_path()</h3>
98
<a class="indexterm" name="id2822710"></a><pre class="programlisting">#define gnome_is_program_in_path(program)</pre>
114
<a class="indexterm" name="id2990532"></a><pre class="programlisting">#define gnome_is_program_in_path(program)</pre>
99
115
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
100
116
<h3 class="title">Warning</h3>
101
117
<p><code class="literal">gnome_is_program_in_path</code> is deprecated and should not be used in newly-written code.</p>
102
118
</div>
103
119
<p>
104
120
Deprecated, use <a
105
href="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#g-find-program-in-path"
121
href="../glib/glib-Miscellaneous-Utility-Functions.html#g-find-program-in-path"
106
122
><span class="type">g_find_program_in_path</span></a></p>
107
123
<p>
108
124
111
127
<col align="left" valign="top">
112
128
<tbody>
113
129
<tr>
114
<td>
115
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
130
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
116
131
<td> A program name.
117
132
</td>
118
133
</tr>
119
134
<tr>
120
<td>
121
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
135
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
122
136
<td> <a
123
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
137
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
124
138
><code class="literal">NULL</code></a> if program is not on the path or a string
125
139
allocated with <a
126
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-malloc"
140
href="../glib/glib-Memory-Allocation.html#g-malloc"
127
141
><code class="function">g_malloc()</code></a> with the full path name of the program
128
142
found.
129
143
</td>
133
147
</div>
134
148
<hr>
135
149
<div class="refsect2" lang="en">
136
<a name="id2822802"></a><h3>
150
<a name="id2990624"></a><h3>
137
151
<a name="g-extension-pointer"></a>g_extension_pointer ()</h3>
138
<a class="indexterm" name="id2822815"></a><pre class="programlisting">const char* g_extension_pointer (const char *path);</pre>
152
<a class="indexterm" name="id2990637"></a><pre class="programlisting">const char* g_extension_pointer (const char *path);</pre>
139
153
<p>
140
154
Extracts the extension from the end of a filename (the part after the final
141
155
'.' in the filename).</p>
146
160
<col align="left" valign="top">
147
161
<tbody>
148
162
<tr>
149
<td>
150
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
163
<td><span class="term"><em class="parameter"><code>path</code></em> :</span></td>
151
164
<td> A filename or file path.
152
165
</td>
153
166
</tr>
154
167
<tr>
155
<td>
156
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
168
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
157
169
<td> A pointer to the extension part of the filename, or a
158
170
pointer to the end of the string if the filename does not
159
171
have an extension.
164
176
</div>
165
177
<hr>
166
178
<div class="refsect2" lang="en">
167
<a name="id2822880"></a><h3>
179
<a name="id2990702"></a><h3>
168
180
<a name="gnome-util-prepend-user-home"></a>gnome_util_prepend_user_home()</h3>
169
<a class="indexterm" name="id2822893"></a><pre class="programlisting">#define gnome_util_prepend_user_home(x)</pre>
181
<a class="indexterm" name="id2990715"></a><pre class="programlisting">#define gnome_util_prepend_user_home(x)</pre>
170
182
<p>
171
183
Prepends the home directory of the user to a filename.
172
184
</p>
174
186
<col align="left" valign="top">
175
187
<tbody>
176
188
<tr>
177
<td>
178
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
189
<td><span class="term"><em class="parameter"><code>x</code></em> :</span></td>
179
190
<td>A relative filename in the user's home directory.
180
191
</td>
181
192
</tr>
182
193
<tr>
183
<td>
184
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
194
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
185
195
<td>A string containing <em class="parameter"><code>x</code></em> with the user's home directory path prepended.
186
196
The string should be freed with <a
187
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
197
href="../glib/glib-Memory-Allocation.html#g-free"
188
198
><code class="function">g_free()</code></a> when no longer required.
189
199
190
200
195
205
</div>
196
206
<hr>
197
207
<div class="refsect2" lang="en">
198
<a name="id2822957"></a><h3>
208
<a name="id2990778"></a><h3>
199
209
<a name="gnome-util-home-file"></a>gnome_util_home_file()</h3>
200
<a class="indexterm" name="id2822970"></a><pre class="programlisting">#define gnome_util_home_file(afile)</pre>
210
<a class="indexterm" name="id2990792"></a><pre class="programlisting">#define gnome_util_home_file(afile)</pre>
201
211
<p>
202
212
Similar to <a href="libgnome-gnome-util.html#gnome-util-prepend-user-home"><code class="function">gnome_util_prepend_user_home()</code></a>, except that "/home/fred/.gnome2",
203
213
instead of just "/home/fred/" is put on the front.
205
215
<div class="variablelist"><table border="0">
206
216
<col align="left" valign="top">
207
217
<tbody><tr>
208
<td>
209
<span class="term"><em class="parameter"><code>afile</code></em> :</span></td>
218
<td><span class="term"><em class="parameter"><code>afile</code></em> :</span></td>
210
219
<td> A filename relative to the user's .gnome2 directory.
211
220
Returns: A string containing <em class="parameter"><code>afile</code></em> with the user's home directory path and
212
221
"/.gnome2" prepended. The string should be freed with <a
213
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
222
href="../glib/glib-Memory-Allocation.html#g-free"
214
223
><code class="function">g_free()</code></a> when no longer
215
224
required.
216
225
221
230
</div>
222
231
<hr>
223
232
<div class="refsect2" lang="en">
224
<a name="id2823036"></a><h3>
233
<a name="id2990858"></a><h3>
225
234
<a name="gnome-util-user-shell"></a>gnome_util_user_shell ()</h3>
226
<a class="indexterm" name="id2823049"></a><pre class="programlisting">char* gnome_util_user_shell (void);</pre>
235
<a class="indexterm" name="id2990871"></a><pre class="programlisting">char* gnome_util_user_shell (void);</pre>
227
236
<p>
228
237
Retrieves the user's preferred shell.</p>
229
238
<p>
232
241
<div class="variablelist"><table border="0">
233
242
<col align="left" valign="top">
234
243
<tbody><tr>
235
<td>
236
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
244
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
237
245
<td> A newly allocated string that is the path to the shell.
238
246
</td>
239
247
</tr></tbody>
241
249
</div>
242
250
<hr>
243
251
<div class="refsect2" lang="en">
244
<a name="id2823090"></a><h3>
252
<a name="id2990912"></a><h3>
245
253
<a name="gnome-setenv"></a>gnome_setenv ()</h3>
246
<a class="indexterm" name="id2823103"></a><pre class="programlisting">int gnome_setenv (const char *name,
254
<a class="indexterm" name="id2990925"></a><pre class="programlisting">int gnome_setenv (const char *name,
247
255
const char *value,
248
256
<a
249
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
257
href="../glib/glib-Basic-Types.html#gboolean"
250
258
>gboolean</a> overwrite);</pre>
251
259
<p>
252
260
Adds "<em class="parameter"><code>name</code></em>=<em class="parameter"><code>value</code></em>" to the environment. Note that on systems without setenv,
256
264
</p>
257
265
<p>
258
266
If <em class="parameter"><code>overwrite</code></em> is <a
259
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
267
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
260
268
><code class="literal">FALSE</code></a> and the variable already exists in the environment,
261
269
then <code class="literal">0</code> is returned and the value is not changed.</p>
262
270
<p>
266
274
<col align="left" valign="top">
267
275
<tbody>
268
276
<tr>
269
<td>
270
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
277
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
271
278
<td> An environment variable name.
272
279
</td>
273
280
</tr>
274
281
<tr>
275
<td>
276
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
282
<td><span class="term"><em class="parameter"><code>value</code></em> :</span></td>
277
283
<td> The value to assign to the environment variable.
278
284
</td>
279
285
</tr>
280
286
<tr>
281
<td>
282
<span class="term"><em class="parameter"><code>overwrite</code></em> :</span></td>
287
<td><span class="term"><em class="parameter"><code>overwrite</code></em> :</span></td>
283
288
<td> If <a
284
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
289
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
285
290
><code class="literal">TRUE</code></a>, overwrite the existing <em class="parameter"><code>name</code></em> variable in the
286
291
environment.
287
292
</td>
288
293
</tr>
289
294
<tr>
290
<td>
291
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
295
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
292
296
<td> <code class="literal">0</code> on success, <code class="literal">-1</code> on error
293
297
294
298
</td>
298
302
</div>
299
303
<hr>
300
304
<div class="refsect2" lang="en">
301
<a name="id2823311"></a><h3>
305
<a name="id2991134"></a><h3>
302
306
<a name="gnome-unsetenv"></a>gnome_unsetenv ()</h3>
303
<a class="indexterm" name="id2823324"></a><pre class="programlisting">void gnome_unsetenv (const char *name);</pre>
307
<a class="indexterm" name="id2991146"></a><pre class="programlisting">void gnome_unsetenv (const char *name);</pre>
304
308
<p>
305
309
Removes <em class="parameter"><code>name</code></em> from the environment.
306
310
In case there is no native implementation of unsetenv,
312
316
<div class="variablelist"><table border="0">
313
317
<col align="left" valign="top">
314
318
<tbody><tr>
315
<td>
316
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
319
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
317
320
<td> The environment variable to unset.
318
321
</td>
319
322
</tr></tbody>
321
324
</div>
322
325
<hr>
323
326
<div class="refsect2" lang="en">
324
<a name="id2823382"></a><h3>
327
<a name="id2991205"></a><h3>
325
328
<a name="gnome-clearenv"></a>gnome_clearenv ()</h3>
326
<a class="indexterm" name="id2823395"></a><pre class="programlisting">void gnome_clearenv (void);</pre>
329
<a class="indexterm" name="id2991218"></a><pre class="programlisting">void gnome_clearenv (void);</pre>
327
330
<p>
328
331
Clears out the environment completely.
329
332
In case there is no native implementation of clearenv,
335
338
</div>
336
339
<hr>
337
340
<div class="refsect2" lang="en">
338
<a name="id2823422"></a><h3>
341
<a name="id2991245"></a><h3>
339
342
<a name="g-concat-dir-and-file"></a>g_concat_dir_and_file()</h3>
340
<a class="indexterm" name="id2823438"></a><pre class="programlisting">#define g_concat_dir_and_file(dir,file)</pre>
343
<a class="indexterm" name="id2991260"></a><pre class="programlisting">#define g_concat_dir_and_file(dir,file)</pre>
341
344
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
342
345
<h3 class="title">Warning</h3>
343
346
<p><code class="literal">g_concat_dir_and_file</code> is deprecated and should not be used in newly-written code.</p>
344
347
</div>
345
348
<p>
346
349
Programs should use <a
347
href="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#g-build-filename"
350
href="../glib/glib-Miscellaneous-Utility-Functions.html#g-build-filename"
348
351
><code class="function">g_build_filename()</code></a> instead of this function.
349
352
</p>
350
353
<div class="variablelist"><table border="0">
351
354
<col align="left" valign="top">
352
355
<tbody>
353
356
<tr>
354
<td>
355
<span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
357
<td><span class="term"><em class="parameter"><code>dir</code></em> :</span></td>
356
358
<td>Directory name.
357
359
</td>
358
360
</tr>
359
361
<tr>
360
<td>
361
<span class="term"><em class="parameter"><code>file</code></em> :</span></td>
362
<td><span class="term"><em class="parameter"><code>file</code></em> :</span></td>
362
363
<td>Filename.
363
364
</td>
364
365
</tr>
365
366
<tr>
366
<td>
367
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
367
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
368
368
<td>A newly allocated string that is the concatenation of <em class="parameter"><code>dir</code></em> and <em class="parameter"><code>file</code></em>,
369
369
with seperators appropriate for the filesystem automatically taken care of.
370
370
376
376
</div>
377
377
<hr>
378
378
<div class="refsect2" lang="en">
379
<a name="id2823535"></a><h3>
379
<a name="id2991357"></a><h3>
380
380
<a name="g-file-exists"></a>g_file_exists()</h3>
381
<a class="indexterm" name="id2823550"></a><pre class="programlisting">#define g_file_exists(filename)</pre>
381
<a class="indexterm" name="id2991372"></a><pre class="programlisting">#define g_file_exists(filename)</pre>
382
382
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
383
383
<h3 class="title">Warning</h3>
384
384
<p><code class="literal">g_file_exists</code> is deprecated and should not be used in newly-written code.</p>
391
391
<col align="left" valign="top">
392
392
<tbody>
393
393
<tr>
394
<td>
395
<span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
394
<td><span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
396
395
<td>Filename.
397
396
</td>
398
397
</tr>
399
398
<tr>
400
<td>
401
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
399
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
402
400
<td>Returns <a
403
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
401
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
404
402
><code class="literal">TRUE</code></a> if <em class="parameter"><code>filename</code></em> exists, <a
405
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
403
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
406
404
><code class="literal">FALSE</code></a> otherwise.
407
405
408
406
413
411
</div>
414
412
<hr>
415
413
<div class="refsect2" lang="en">
416
<a name="id2823640"></a><h3>
414
<a name="id2991463"></a><h3>
417
415
<a name="g-unix-error-string"></a>g_unix_error_string()</h3>
418
<a class="indexterm" name="id2823656"></a><pre class="programlisting">#define g_unix_error_string(error_num)</pre>
416
<a class="indexterm" name="id2991478"></a><pre class="programlisting">#define g_unix_error_string(error_num)</pre>
419
417
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
420
418
<h3 class="title">Warning</h3>
421
419
<p><code class="literal">g_unix_error_string</code> is deprecated and should not be used in newly-written code.</p>
422
420
</div>
423
421
<p>
424
422
Programs should use <a
425
href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strerror"
423
href="../glib/glib-String-Utility-Functions.html#g-strerror"
426
424
><code class="function">g_strerror()</code></a> instead of this function. Also, note that the
427
425
returned string is only valid until the next call to <a
428
href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strerror"
426
href="../glib/glib-String-Utility-Functions.html#g-strerror"
429
427
><code class="function">g_strerror()</code></a> or
430
428
<a href="libgnome-gnome-util.html#g-unix-error-string"><code class="function">g_unix_error_string()</code></a>.
431
429
</p>
433
431
<col align="left" valign="top">
434
432
<tbody>
435
433
<tr>
436
<td>
437
<span class="term"><em class="parameter"><code>error_num</code></em> :</span></td>
434
<td><span class="term"><em class="parameter"><code>error_num</code></em> :</span></td>
438
435
<td>A system error number (see C <span class="type">errno</span> documentation for more info).
439
436
</td>
440
437
</tr>
441
438
<tr>
442
<td>
443
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
439
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
444
440
<td>A string describing the error code.
445
441
446
442
451
447
</div>
452
448
<hr>
453
449
<div class="refsect2" lang="en">
454
<a name="id2823756"></a><h3>
450
<a name="id2991578"></a><h3>
455
451
<a name="gnome-util-user-home"></a>gnome_util_user_home()</h3>
456
<a class="indexterm" name="id2823771"></a><pre class="programlisting">#define gnome_util_user_home()</pre>
452
<a class="indexterm" name="id2991593"></a><pre class="programlisting">#define gnome_util_user_home()</pre>
457
453
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
458
454
<h3 class="title">Warning</h3>
459
455
<p><code class="literal">gnome_util_user_home</code> is deprecated and should not be used in newly-written code.</p>
460
456
</div>
461
457
<p>
462
458
Programs should use <a
463
href="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#g-get-home-dir"
459
href="../glib/glib-Miscellaneous-Utility-Functions.html#g-get-home-dir"
464
460
><code class="function">g_get_home_dir()</code></a> instead of this function.
465
461
</p>
466
462
<div class="variablelist"><table border="0">
467
463
<col align="left" valign="top">
468
464
<tbody><tr>
469
<td>
470
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
465
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
471
466
<td>The current user's home directory.
472
467
473
468
477
472
</div>
478
473
<hr>
479
474
<div class="refsect2" lang="en">
480
<a name="id2823827"></a><h3>
475
<a name="id2991649"></a><h3>
481
476
<a name="g-copy-vector"></a>g_copy_vector()</h3>
482
<a class="indexterm" name="id2823842"></a><pre class="programlisting">#define g_copy_vector(vec)</pre>
477
<a class="indexterm" name="id2991663"></a><pre class="programlisting">#define g_copy_vector(vec)</pre>
483
478
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
484
479
<h3 class="title">Warning</h3>
485
480
<p><code class="literal">g_copy_vector</code> is deprecated and should not be used in newly-written code.</p>
486
481
</div>
487
482
<p>
488
483
Use <a
489
href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strdupv"
484
href="../glib/glib-String-Utility-Functions.html#g-strdupv"
490
485
><code class="function">g_strdupv()</code></a> instead of this function.
491
486
</p>
492
487
<div class="variablelist"><table border="0">
493
488
<col align="left" valign="top">
494
489
<tbody>
495
490
<tr>
496
<td>
497
<span class="term"><em class="parameter"><code>vec</code></em> :</span></td>
491
<td><span class="term"><em class="parameter"><code>vec</code></em> :</span></td>
498
492
<td>An array of strings. <a
499
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
493
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
500
494
><code class="literal">NULL</code></a> terminated.
501
495
</td>
502
496
</tr>
503
497
<tr>
504
<td>
505
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
498
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
506
499
<td>A copy of the <a
507
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
500
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
508
501
><code class="literal">NULL</code></a>-terminated string array.
509
502
510
503
515
508
</div>
516
509
<hr>
517
510
<div class="refsect2" lang="en">
518
<a name="id2823931"></a><h3>
511
<a name="id2991753"></a><h3>
519
512
<a name="gnome-libdir-file"></a>gnome_libdir_file()</h3>
520
<a class="indexterm" name="id2823946"></a><pre class="programlisting">#define gnome_libdir_file(f)</pre>
513
<a class="indexterm" name="id2991768"></a><pre class="programlisting">#define gnome_libdir_file(f)</pre>
521
514
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
522
515
<h3 class="title">Warning</h3>
523
516
<p><code class="literal">gnome_libdir_file</code> is deprecated and should not be used in newly-written code.</p>
529
522
<col align="left" valign="top">
530
523
<tbody>
531
524
<tr>
532
<td>
533
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
525
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
534
526
<td>Filename.
535
527
</td>
536
528
</tr>
537
529
<tr>
538
<td>
539
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
530
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
540
531
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
541
532
library directory (not the application's directory).
542
533
548
539
</div>
549
540
<hr>
550
541
<div class="refsect2" lang="en">
551
<a name="id2824022"></a><h3>
542
<a name="id2991843"></a><h3>
552
543
<a name="gnome-datadir-file"></a>gnome_datadir_file()</h3>
553
<a class="indexterm" name="id2824037"></a><pre class="programlisting">#define gnome_datadir_file(f)</pre>
544
<a class="indexterm" name="id2991858"></a><pre class="programlisting">#define gnome_datadir_file(f)</pre>
554
545
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
555
546
<h3 class="title">Warning</h3>
556
547
<p><code class="literal">gnome_datadir_file</code> is deprecated and should not be used in newly-written code.</p>
562
553
<col align="left" valign="top">
563
554
<tbody>
564
555
<tr>
565
<td>
566
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
556
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
567
557
<td>Filename.
568
558
</td>
569
559
</tr>
570
560
<tr>
571
<td>
572
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
561
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
573
562
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
574
563
data directory (not the application's directory).
575
564
581
570
</div>
582
571
<hr>
583
572
<div class="refsect2" lang="en">
584
<a name="id2824112"></a><h3>
573
<a name="id2991933"></a><h3>
585
574
<a name="gnome-sound-file"></a>gnome_sound_file()</h3>
586
<a class="indexterm" name="id2824127"></a><pre class="programlisting">#define gnome_sound_file(f)</pre>
575
<a class="indexterm" name="id2991949"></a><pre class="programlisting">#define gnome_sound_file(f)</pre>
587
576
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
588
577
<h3 class="title">Warning</h3>
589
578
<p><code class="literal">gnome_sound_file</code> is deprecated and should not be used in newly-written code.</p>
595
584
<col align="left" valign="top">
596
585
<tbody>
597
586
<tr>
598
<td>
599
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
587
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
600
588
<td>Filename.
601
589
</td>
602
590
</tr>
603
591
<tr>
604
<td>
605
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
592
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
606
593
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
607
594
sound files directory (not the application's directory).
608
595
614
601
</div>
615
602
<hr>
616
603
<div class="refsect2" lang="en">
617
<a name="id2824203"></a><h3>
604
<a name="id2992024"></a><h3>
618
605
<a name="gnome-pixmap-file"></a>gnome_pixmap_file()</h3>
619
<a class="indexterm" name="id2824218"></a><pre class="programlisting">#define gnome_pixmap_file(f)</pre>
606
<a class="indexterm" name="id2992039"></a><pre class="programlisting">#define gnome_pixmap_file(f)</pre>
620
607
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
621
608
<h3 class="title">Warning</h3>
622
609
<p><code class="literal">gnome_pixmap_file</code> is deprecated and should not be used in newly-written code.</p>
628
615
<col align="left" valign="top">
629
616
<tbody>
630
617
<tr>
631
<td>
632
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
618
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
633
619
<td>Filename.
634
620
</td>
635
621
</tr>
636
622
<tr>
637
<td>
638
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
623
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
639
624
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
640
625
pixmap directory (not the application's directory).
641
626
647
632
</div>
648
633
<hr>
649
634
<div class="refsect2" lang="en">
650
<a name="id2824293"></a><h3>
635
<a name="id2992114"></a><h3>
651
636
<a name="gnome-config-file"></a>gnome_config_file()</h3>
652
<a class="indexterm" name="id2824308"></a><pre class="programlisting">#define gnome_config_file(f)</pre>
637
<a class="indexterm" name="id2992129"></a><pre class="programlisting">#define gnome_config_file(f)</pre>
653
638
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
654
639
<h3 class="title">Warning</h3>
655
640
<p><code class="literal">gnome_config_file</code> is deprecated and should not be used in newly-written code.</p>
661
646
<col align="left" valign="top">
662
647
<tbody>
663
648
<tr>
664
<td>
665
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
649
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
666
650
<td>Filename.
667
651
</td>
668
652
</tr>
669
653
<tr>
670
<td>
671
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
654
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
672
655
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
673
656
config directory (not the application's directory).
674
657
680
663
</div>
681
664
<hr>
682
665
<div class="refsect2" lang="en">
683
<a name="id2824383"></a><h3>
666
<a name="id2992204"></a><h3>
684
667
<a name="gnome-unconditional-libdir-file"></a>gnome_unconditional_libdir_file()</h3>
685
<a class="indexterm" name="id2824399"></a><pre class="programlisting">#define gnome_unconditional_libdir_file(f)</pre>
668
<a class="indexterm" name="id2992220"></a><pre class="programlisting">#define gnome_unconditional_libdir_file(f)</pre>
686
669
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
687
670
<h3 class="title">Warning</h3>
688
671
<p><code class="literal">gnome_unconditional_libdir_file</code> is deprecated and should not be used in newly-written code.</p>
694
677
<col align="left" valign="top">
695
678
<tbody>
696
679
<tr>
697
<td>
698
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
680
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
699
681
<td>Filename.
700
682
</td>
701
683
</tr>
702
684
<tr>
703
<td>
704
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
685
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
705
686
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
706
687
library directory (not the application's directory).
707
688
713
694
</div>
714
695
<hr>
715
696
<div class="refsect2" lang="en">
716
<a name="id2824475"></a><h3>
697
<a name="id2992296"></a><h3>
717
698
<a name="gnome-unconditional-datadir-file"></a>gnome_unconditional_datadir_file()</h3>
718
<a class="indexterm" name="id2824491"></a><pre class="programlisting">#define gnome_unconditional_datadir_file(f)</pre>
699
<a class="indexterm" name="id2992312"></a><pre class="programlisting">#define gnome_unconditional_datadir_file(f)</pre>
719
700
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
720
701
<h3 class="title">Warning</h3>
721
702
<p><code class="literal">gnome_unconditional_datadir_file</code> is deprecated and should not be used in newly-written code.</p>
727
708
<col align="left" valign="top">
728
709
<tbody>
729
710
<tr>
730
<td>
731
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
711
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
732
712
<td>Filename.
733
713
</td>
734
714
</tr>
735
715
<tr>
736
<td>
737
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
716
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
738
717
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
739
718
data directory (not the application's directory).
740
719
746
725
</div>
747
726
<hr>
748
727
<div class="refsect2" lang="en">
749
<a name="id2824567"></a><h3>
728
<a name="id2992388"></a><h3>
750
729
<a name="gnome-unconditional-sound-file"></a>gnome_unconditional_sound_file()</h3>
751
<a class="indexterm" name="id2824582"></a><pre class="programlisting">#define gnome_unconditional_sound_file(f)</pre>
730
<a class="indexterm" name="id2992403"></a><pre class="programlisting">#define gnome_unconditional_sound_file(f)</pre>
752
731
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
753
732
<h3 class="title">Warning</h3>
754
733
<p><code class="literal">gnome_unconditional_sound_file</code> is deprecated and should not be used in newly-written code.</p>
760
739
<col align="left" valign="top">
761
740
<tbody>
762
741
<tr>
763
<td>
764
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
742
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
765
743
<td>Filename.
766
744
</td>
767
745
</tr>
768
746
<tr>
769
<td>
770
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
747
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
771
748
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
772
749
sound files directory (not the application's directory).
773
750
779
756
</div>
780
757
<hr>
781
758
<div class="refsect2" lang="en">
782
<a name="id2824659"></a><h3>
759
<a name="id2992479"></a><h3>
783
760
<a name="gnome-unconditional-pixmap-file"></a>gnome_unconditional_pixmap_file()</h3>
784
<a class="indexterm" name="id2824675"></a><pre class="programlisting">#define gnome_unconditional_pixmap_file(f)</pre>
761
<a class="indexterm" name="id2992495"></a><pre class="programlisting">#define gnome_unconditional_pixmap_file(f)</pre>
785
762
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
786
763
<h3 class="title">Warning</h3>
787
764
<p><code class="literal">gnome_unconditional_pixmap_file</code> is deprecated and should not be used in newly-written code.</p>
793
770
<col align="left" valign="top">
794
771
<tbody>
795
772
<tr>
796
<td>
797
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
773
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
798
774
<td>Filename.
799
775
</td>
800
776
</tr>
801
777
<tr>
802
<td>
803
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
778
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
804
779
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
805
780
pixmap directory (not the application's directory).
806
781
812
787
</div>
813
788
<hr>
814
789
<div class="refsect2" lang="en">
815
<a name="id2824751"></a><h3>
790
<a name="id2992571"></a><h3>
816
791
<a name="gnome-unconditional-config-file"></a>gnome_unconditional_config_file()</h3>
817
<a class="indexterm" name="id2824767"></a><pre class="programlisting">#define gnome_unconditional_config_file(f)</pre>
792
<a class="indexterm" name="id2992587"></a><pre class="programlisting">#define gnome_unconditional_config_file(f)</pre>
818
793
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
819
794
<h3 class="title">Warning</h3>
820
795
<p><code class="literal">gnome_unconditional_config_file</code> is deprecated and should not be used in newly-written code.</p>
826
801
<col align="left" valign="top">
827
802
<tbody>
828
803
<tr>
829
<td>
830
<span class="term"><em class="parameter"><code>f</code></em> :</span></td>
804
<td><span class="term"><em class="parameter"><code>f</code></em> :</span></td>
831
805
<td>Filename.
832
806
</td>
833
807
</tr>
834
808
<tr>
835
<td>
836
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
809
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
837
810
<td>A full path to the file <em class="parameter"><code>f</code></em> that is stored in the system's GNOME
838
811
config directory (not the application's directory).
839
812
Loggerhead is a web-based interface for Breezy
Version: 2.0.1