~ubuntu-branches/ubuntu/feisty/libgnome/feisty
» Revision
22
: doc/reference/html/libgnome-gnome-help.html
« back to all changes in this revision
Viewing changes to doc/reference/html/libgnome-gnome-help.html
- browse files at revision 22
- compare with another revision
- download diff
- download tarball
- view history from revision 22
- Committer: Bazaar Package Importer
- Author(s): Daniel Holbach
- Date: 2007-01-09 10:07:49 UTC
- mfrom: (1.1.12 upstream)
- Revision ID: james.westby@ubuntu.com-20070109100749-uc3lve73086th31g
Tags: 2.17.2-0ubuntu1
New upstream release.
- files modified:
- ChangeLog
added
removed
doc/reference/html/libgnome-gnome-help.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gnome-help</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7
7
<link rel="start" href="index.html" title="GNOME Library Reference Manual">
8
8
<link rel="up" href="ch03.html" title="Displaying Help and External Info">
9
9
<link rel="prev" href="ch03.html" title="Displaying Help and External Info">
37
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
38
38
<td><a accesskey="n" href="libgnome-gnome-url.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
39
39
</tr>
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2735086" class="shortcut">Top</a>
40
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2536808" class="shortcut">Top</a>
41
41
 | 
42
<a href="#id2736336" class="shortcut">Description</a></nobr></td></tr>
42
<a href="#id2537918" class="shortcut">Description</a></nobr></td></tr>
43
43
</table>
44
44
<div class="refentry" lang="en">
45
45
<a name="libgnome-gnome-help"></a><div class="titlepage"></div>
46
46
<div class="refnamediv"><table width="100%"><tr>
47
47
<td valign="top">
48
48
<h2>
49
<a name="id2735086"></a><span class="refentrytitle">gnome-help</span>
49
<a name="id2536808"></a><span class="refentrytitle">gnome-help</span>
50
50
</h2>
51
51
<p>gnome-help — Display application and GNOME system help.</p>
52
52
</td>
97
97
</pre>
98
98
</div>
99
99
<div class="refsect1" lang="en">
100
<a name="id2736336"></a><h2>Description</h2>
100
<a name="id2537918"></a><h2>Description</h2>
101
101
<p>
102
102
These functions provide a way to display help files that are either installed
103
103
as part of the main GNOME installation or that are specific to the current
105
105
</p>
106
106
</div>
107
107
<div class="refsect1" lang="en">
108
<a name="id2736353"></a><h2>Details</h2>
108
<a name="id2537935"></a><h2>Details</h2>
109
109
<div class="refsect2" lang="en">
110
<a name="id2736364"></a><h3>
110
<a name="id2537945"></a><h3>
111
111
<a name="GnomeHelpError"></a>enum GnomeHelpError</h3>
112
<a class="indexterm" name="id2736376"></a><pre class="programlisting">typedef enum {
112
<a class="indexterm" name="id2537958"></a><pre class="programlisting">typedef enum {
113
113
GNOME_HELP_ERROR_INTERNAL,
114
114
GNOME_HELP_ERROR_NOT_FOUND
115
115
} GnomeHelpError;
121
121
<col align="left" valign="top">
122
122
<tbody>
123
123
<tr>
124
<td><span class="term"><a name="GNOME-HELP-ERROR-INTERNAL:CAPS"></a><code class="literal">GNOME_HELP_ERROR_INTERNAL</code></span></td>
124
<td>
125
<span class="term"><a name="GNOME-HELP-ERROR-INTERNAL:CAPS"></a><code class="literal">GNOME_HELP_ERROR_INTERNAL</code></span></td>
125
126
<td>Something went wrong internally. This is most
126
127
likely caused by a resource problem or bad installation.
127
128
</td>
128
129
</tr>
129
130
<tr>
130
<td><span class="term"><a name="GNOME-HELP-ERROR-NOT-FOUND:CAPS"></a><code class="literal">GNOME_HELP_ERROR_NOT_FOUND</code></span></td>
131
<td>
132
<span class="term"><a name="GNOME-HELP-ERROR-NOT-FOUND:CAPS"></a><code class="literal">GNOME_HELP_ERROR_NOT_FOUND</code></span></td>
131
133
<td>Help file does not exist.
132
134
133
135
</td>
137
139
</div>
138
140
<hr>
139
141
<div class="refsect2" lang="en">
140
<a name="id2736455"></a><h3>
142
<a name="id2538037"></a><h3>
141
143
<a name="GNOME-HELP-ERROR:CAPS"></a>GNOME_HELP_ERROR</h3>
142
<a class="indexterm" name="id2736469"></a><pre class="programlisting">#define GNOME_HELP_ERROR (gnome_help_error_quark ())
144
<a class="indexterm" name="id2538051"></a><pre class="programlisting">#define GNOME_HELP_ERROR (gnome_help_error_quark ())
143
145
</pre>
144
146
<p>
145
147
The class (or domain) of errors raised directly by the gnome-help module. This
148
150
</div>
149
151
<hr>
150
152
<div class="refsect2" lang="en">
151
<a name="id2736495"></a><h3>
153
<a name="id2538077"></a><h3>
152
154
<a name="gnome-help-display"></a>gnome_help_display ()</h3>
153
<a class="indexterm" name="id2736508"></a><pre class="programlisting">gboolean gnome_help_display (const char *file_name,
155
<a class="indexterm" name="id2538090"></a><pre class="programlisting">gboolean gnome_help_display (const char *file_name,
154
156
const char *link_id,
155
157
GError **error);</pre>
156
158
<p>
163
165
<col align="left" valign="top">
164
166
<tbody>
165
167
<tr>
166
<td><span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
168
<td>
169
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
167
170
<td> The name of the help document to display.
168
171
</td>
169
172
</tr>
170
173
<tr>
171
<td><span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
172
<td> Can be <a
173
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
174
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
174
<td>
175
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
176
<td> Can be <code class="literal">NULL</code>. If set, refers to an anchor or section id within the
175
177
requested document.
176
178
</td>
177
179
</tr>
178
180
<tr>
179
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
181
<td>
182
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
180
183
<td> A <span class="type">GError</span> instance that will hold the specifics of any error which
181
occurs during processing, or <a
182
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
183
><code class="literal">NULL</code></a>
184
occurs during processing, or <code class="literal">NULL</code>
184
185
</td>
185
186
</tr>
186
187
<tr>
187
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
188
<td>
189
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
188
190
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>error</code></em> will
189
191
contain the actual error).
190
192
</td>
194
196
</div>
195
197
<hr>
196
198
<div class="refsect2" lang="en">
197
<a name="id2736681"></a><h3>
199
<a name="id2538263"></a><h3>
198
200
<a name="gnome-help-display-with-doc-id"></a>gnome_help_display_with_doc_id ()</h3>
199
<a class="indexterm" name="id2736694"></a><pre class="programlisting">gboolean gnome_help_display_with_doc_id (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
201
<a class="indexterm" name="id2538276"></a><pre class="programlisting">gboolean gnome_help_display_with_doc_id (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
200
202
const char *doc_id,
201
203
const char *file_name,
202
204
const char *link_id,
224
226
<col align="left" valign="top">
225
227
<tbody>
226
228
<tr>
227
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
228
<td> The current application object, or <a
229
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
230
><code class="literal">NULL</code></a> for the default one.
229
<td>
230
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
231
<td> The current application object, or <code class="literal">NULL</code> for the default one.
231
232
</td>
232
233
</tr>
233
234
<tr>
234
<td><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
235
<td> The document identifier, or <a
236
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
237
><code class="literal">NULL</code></a> to default to the application ID
235
<td>
236
<span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
237
<td> The document identifier, or <code class="literal">NULL</code> to default to the application ID
238
238
(app_id) of the specified <em class="parameter"><code>program</code></em>.
239
239
</td>
240
240
</tr>
241
241
<tr>
242
<td><span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
242
<td>
243
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
243
244
<td> The name of the help document to display.
244
245
</td>
245
246
</tr>
246
247
<tr>
247
<td><span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
248
<td> Can be <a
249
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
250
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
248
<td>
249
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
250
<td> Can be <code class="literal">NULL</code>. If set, refers to an anchor or section id within the
251
251
requested document.
252
252
</td>
253
253
</tr>
254
254
<tr>
255
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
255
<td>
256
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
256
257
<td> A <span class="type">GError</span> instance that will hold the specifics of any error which
257
occurs during processing, or <a
258
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
259
><code class="literal">NULL</code></a>
258
occurs during processing, or <code class="literal">NULL</code>
260
259
</td>
261
260
</tr>
262
261
<tr>
263
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
262
<td>
263
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
264
264
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>error</code></em> will
265
265
contain the actual error).
266
266
</td>
270
270
</div>
271
271
<hr>
272
272
<div class="refsect2" lang="en">
273
<a name="id2737015"></a><h3>
273
<a name="id2538597"></a><h3>
274
274
<a name="gnome-help-display-with-doc-id-and-env"></a>gnome_help_display_with_doc_id_and_env ()</h3>
275
<a class="indexterm" name="id2737032"></a><pre class="programlisting">gboolean gnome_help_display_with_doc_id_and_env
275
<a class="indexterm" name="id2538613"></a><pre class="programlisting">gboolean gnome_help_display_with_doc_id_and_env
276
276
(<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
277
277
const char *doc_id,
278
278
const char *file_name,
290
290
<col align="left" valign="top">
291
291
<tbody>
292
292
<tr>
293
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
294
<td> The current application object, or <a
295
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
296
><code class="literal">NULL</code></a> for the default one.
293
<td>
294
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
295
<td> The current application object, or <code class="literal">NULL</code> for the default one.
297
296
</td>
298
297
</tr>
299
298
<tr>
300
<td><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
301
<td> The document identifier, or <a
302
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
303
><code class="literal">NULL</code></a> to default to empty string.
299
<td>
300
<span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
301
<td> The document identifier, or <code class="literal">NULL</code> to default to empty string.
304
302
(app_id) of the specified <em class="parameter"><code>program</code></em>.
305
303
</td>
306
304
</tr>
307
305
<tr>
308
<td><span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
306
<td>
307
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
309
308
<td> The name of the help document to display.
310
309
</td>
311
310
</tr>
312
311
<tr>
313
<td><span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
314
<td> Can be <a
315
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
316
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
312
<td>
313
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
314
<td> Can be <code class="literal">NULL</code>. If set, refers to an anchor or section id within the
317
315
requested document.
318
316
</td>
319
317
</tr>
320
318
<tr>
321
<td><span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
322
<td> child's environment, or <a
323
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
324
><code class="literal">NULL</code></a> to inherit parent's.
319
<td>
320
<span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
321
<td> child's environment, or <code class="literal">NULL</code> to inherit parent's.
325
322
</td>
326
323
</tr>
327
324
<tr>
328
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
325
<td>
326
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
329
327
<td> A <span class="type">GError</span> instance that will hold the specifics of any error which
330
occurs during processing, or <a
331
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
332
><code class="literal">NULL</code></a>
328
occurs during processing, or <code class="literal">NULL</code>
333
329
</td>
334
330
</tr>
335
331
<tr>
336
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
332
<td>
333
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
337
334
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>error</code></em> will
338
335
contain the actual error).
339
336
341
338
</tr>
342
339
</tbody>
343
340
</table></div>
344
<p class="since">Since 2.2
341
<p>Since 2.2
345
342
</p>
346
343
</div>
347
344
<hr>
348
345
<div class="refsect2" lang="en">
349
<a name="id2737324"></a><h3>
346
<a name="id2538904"></a><h3>
350
347
<a name="gnome-help-display-desktop"></a>gnome_help_display_desktop ()</h3>
351
<a class="indexterm" name="id2737338"></a><pre class="programlisting">gboolean gnome_help_display_desktop (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
348
<a class="indexterm" name="id2538918"></a><pre class="programlisting">gboolean gnome_help_display_desktop (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
352
349
const char *doc_id,
353
350
const char *file_name,
354
351
const char *link_id,
371
368
<col align="left" valign="top">
372
369
<tbody>
373
370
<tr>
374
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
375
<td> The current application object, or <a
376
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
377
><code class="literal">NULL</code></a> for the default one.
371
<td>
372
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
373
<td> The current application object, or <code class="literal">NULL</code> for the default one.
378
374
</td>
379
375
</tr>
380
376
<tr>
381
<td><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
377
<td>
378
<span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
382
379
<td> The name of the help file relative to the system's help domain
383
380
(<a href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
384
381
</td>
385
382
</tr>
386
383
<tr>
387
<td><span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
384
<td>
385
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
388
386
<td> The name of the help document to display.
389
387
</td>
390
388
</tr>
391
389
<tr>
392
<td><span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
393
<td> Can be <a
394
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
395
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
390
<td>
391
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
392
<td> Can be <code class="literal">NULL</code>. If set, refers to an anchor or section id within the
396
393
requested document.
397
394
</td>
398
395
</tr>
399
396
<tr>
400
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
397
<td>
398
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
401
399
<td> A <span class="type">GError</span> instance that will hold the specifics of any error which
402
occurs during processing, or <a
403
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
404
><code class="literal">NULL</code></a>
400
occurs during processing, or <code class="literal">NULL</code>
405
401
</td>
406
402
</tr>
407
403
<tr>
408
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
404
<td>
405
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
409
406
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>error</code></em> will
410
407
contain the actual error).
411
408
</td>
415
412
</div>
416
413
<hr>
417
414
<div class="refsect2" lang="en">
418
<a name="id2737628"></a><h3>
415
<a name="id2539207"></a><h3>
419
416
<a name="gnome-help-display-desktop-with-env"></a>gnome_help_display_desktop_with_env ()</h3>
420
<a class="indexterm" name="id2737644"></a><pre class="programlisting">gboolean gnome_help_display_desktop_with_env
417
<a class="indexterm" name="id2539223"></a><pre class="programlisting">gboolean gnome_help_display_desktop_with_env
421
418
(<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
422
419
const char *doc_id,
423
420
const char *file_name,
435
432
<col align="left" valign="top">
436
433
<tbody>
437
434
<tr>
438
<td><span class="term"><em class="parameter"><code>program</code></em> :</span></td>
439
<td> The current application object, or <a
440
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
441
><code class="literal">NULL</code></a> for the default one.
435
<td>
436
<span class="term"><em class="parameter"><code>program</code></em> :</span></td>
437
<td> The current application object, or <code class="literal">NULL</code> for the default one.
442
438
</td>
443
439
</tr>
444
440
<tr>
445
<td><span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
441
<td>
442
<span class="term"><em class="parameter"><code>doc_id</code></em> :</span></td>
446
443
<td> The name of the help file relative to the system's help domain
447
444
(<a href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
448
445
</td>
449
446
</tr>
450
447
<tr>
451
<td><span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
448
<td>
449
<span class="term"><em class="parameter"><code>file_name</code></em> :</span></td>
452
450
<td> The name of the help document to display.
453
451
</td>
454
452
</tr>
455
453
<tr>
456
<td><span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
457
<td> Can be <a
458
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
459
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
454
<td>
455
<span class="term"><em class="parameter"><code>link_id</code></em> :</span></td>
456
<td> Can be <code class="literal">NULL</code>. If set, refers to an anchor or section id within the
460
457
requested document.
461
458
</td>
462
459
</tr>
463
460
<tr>
464
<td><span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
465
<td> child's environment, or <a
466
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
467
><code class="literal">NULL</code></a> to inherit parent's.
461
<td>
462
<span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
463
<td> child's environment, or <code class="literal">NULL</code> to inherit parent's.
468
464
</td>
469
465
</tr>
470
466
<tr>
471
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
467
<td>
468
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
472
469
<td> A <span class="type">GError</span> instance that will hold the specifics of any error which
473
occurs during processing, or <a
474
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
475
><code class="literal">NULL</code></a>
470
occurs during processing, or <code class="literal">NULL</code>
476
471
</td>
477
472
</tr>
478
473
<tr>
479
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
474
<td>
475
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
480
476
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>error</code></em> will
481
477
contain the actual error).
482
478
484
480
</tr>
485
481
</tbody>
486
482
</table></div>
487
<p class="since">Since 2.2
483
<p>Since 2.2
488
484
</p>
489
485
</div>
490
486
<hr>
491
487
<div class="refsect2" lang="en">
492
<a name="id2737928"></a><h3>
488
<a name="id2539505"></a><h3>
493
489
<a name="gnome-help-display-uri"></a>gnome_help_display_uri ()</h3>
494
<a class="indexterm" name="id2737940"></a><pre class="programlisting">gboolean gnome_help_display_uri (const char *help_uri,
490
<a class="indexterm" name="id2539517"></a><pre class="programlisting">gboolean gnome_help_display_uri (const char *help_uri,
495
491
GError **error);</pre>
496
492
<p>
497
493
Displays <em class="parameter"><code>help_uri</code></em> in the user's preferred viewer. You should never need to
506
502
<col align="left" valign="top">
507
503
<tbody>
508
504
<tr>
509
<td><span class="term"><em class="parameter"><code>help_uri</code></em> :</span></td>
505
<td>
506
<span class="term"><em class="parameter"><code>help_uri</code></em> :</span></td>
510
507
<td> The URI to display.
511
508
</td>
512
509
</tr>
513
510
<tr>
514
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
511
<td>
512
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
515
513
<td> A <span class="type">GError</span> instance that will hold the specifics of any error which
516
occurs during processing, or <a
517
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
518
><code class="literal">NULL</code></a>
514
occurs during processing, or <code class="literal">NULL</code>
519
515
</td>
520
516
</tr>
521
517
<tr>
522
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
518
<td>
519
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
523
520
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>error</code></em> will
524
521
contain the actual error).
525
522
</td>
529
526
</div>
530
527
<hr>
531
528
<div class="refsect2" lang="en">
532
<a name="id2738091"></a><h3>
529
<a name="id2539668"></a><h3>
533
530
<a name="gnome-help-display-uri-with-env"></a>gnome_help_display_uri_with_env ()</h3>
534
<a class="indexterm" name="id2738106"></a><pre class="programlisting">gboolean gnome_help_display_uri_with_env (const char *help_uri,
531
<a class="indexterm" name="id2539683"></a><pre class="programlisting">gboolean gnome_help_display_uri_with_env (const char *help_uri,
535
532
char **envp,
536
533
GError **error);</pre>
537
534
<p>
545
542
<col align="left" valign="top">
546
543
<tbody>
547
544
<tr>
548
<td><span class="term"><em class="parameter"><code>help_uri</code></em> :</span></td>
545
<td>
546
<span class="term"><em class="parameter"><code>help_uri</code></em> :</span></td>
549
547
<td> The URI to display.
550
548
</td>
551
549
</tr>
552
550
<tr>
553
<td><span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
554
<td> child's environment, or <a
555
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
556
><code class="literal">NULL</code></a> to inherit parent's.
551
<td>
552
<span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
553
<td> child's environment, or <code class="literal">NULL</code> to inherit parent's.
557
554
</td>
558
555
</tr>
559
556
<tr>
560
<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td>
557
<td>
558
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
561
559
<td> A <span class="type">GError</span> instance that will hold the specifics of any error which
562
occurs during processing, or <a
563
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
564
><code class="literal">NULL</code></a>
560
occurs during processing, or <code class="literal">NULL</code>
565
561
</td>
566
562
</tr>
567
563
<tr>
568
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
564
<td>
565
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
569
566
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>error</code></em> will
570
567
contain the actual error).
571
568
573
570
</tr>
574
571
</tbody>
575
572
</table></div>
576
<p class="since">Since 2.2
573
<p>Since 2.2
577
574
</p>
578
575
</div>
579
576
</div>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1