← Back to branch summary

~ubuntu-branches/debian/stretch/libgnome/stretch

« back to all changes in this revision

Viewing changes to doc/reference/html/libgnome-gnome-config.html

  • Committer: Bazaar Package Importer
  • Author(s): Josselin Mouette, Josselin Mouette, Luca Bruno
  • Date: 2009-04-28 12:57:02 UTC
  • mfrom: (1.2.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20090428125702-hvcsq02o58kxa9cu
Tags: 2.26.0-1
http://bugs.debian.org/519263
[ Josselin Mouette ]
* Add libglib2.0-doc to b-d-i to ensure proper xrefs.
* Move gvfs from recommends to depends. Closes: #519263.
* Stop mentioning GNOME 2.

[ Luca Bruno ]
* New upstream release.
* debian/control.in:
  - Bump intltool Build-Depend to 0.40.0.
  - Update to Standards-Version 3.8.1, no additional changes needed.
  - Fix debug package section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/libgnome-gnome-config.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gnome-config</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
7
7
<link rel="home" href="index.html" title="GNOME Library Reference Manual">
8
8
<link rel="up" href="ch06.html" title="Deprecated Modules">
9
9
<link rel="prev" href="ch06.html" title="Deprecated Modules">
10
10
<link rel="next" href="libgnome-gnome-i18n.html" title="gnome-i18n">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.12 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgnome.html" title="Part I. GNOME Library (libgnome)">
14
14
<link rel="chapter" href="ch01.html" title="Initializing Applications and Starting Programs">
37
37
<th width="100%" align="center">GNOME Library Reference Manual</th>
38
38
<td><a accesskey="n" href="libgnome-gnome-i18n.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="#libgnome-gnome-config.synopsis" class="shortcut">Top</a>
 
40
<tr><td colspan="5" class="shortcuts">
 
41
<a href="#libgnome-gnome-config.synopsis" class="shortcut">Top</a>
41
42
                   | 
42
 
                  <a href="#libgnome-gnome-config.description" class="shortcut">Description</a></nobr></td></tr>
 
43
                  <a href="#libgnome-gnome-config.description" class="shortcut">Description</a>
 
44
</td></tr>
43
45
</table>
44
46
<div class="refentry" lang="en">
45
47
<a name="libgnome-gnome-config"></a><div class="titlepage"></div>
96
98
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-vector-with-default" title="gnome_config_private_get_vector_with_default()">gnome_config_private_get_vector_with_default</a>(path, argcp, argvp, def)
97
99
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-set-vector" title="gnome_config_set_vector()">gnome_config_set_vector</a>             (path,argc,argv)
98
100
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-set-vector" title="gnome_config_private_set_vector()">gnome_config_private_set_vector</a>     (path,argc,argv)
99
 
char*               <a class="link" href="libgnome-gnome-config.html#gnome-config-assemble-vector" title="gnome_config_assemble_vector ()">gnome_config_assemble_vector</a>        (int argc,
 
101
char *              <a class="link" href="libgnome-gnome-config.html#gnome-config-assemble-vector" title="gnome_config_assemble_vector ()">gnome_config_assemble_vector</a>        (int argc,
100
102
                                                         const char *const argv[]);
101
103
 
102
104
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-has-section" title="gnome_config_has_section()">gnome_config_has_section</a>            (path)
105
107
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-init-iterator" title="gnome_config_private_init_iterator()">gnome_config_private_init_iterator</a>  (path)
106
108
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-init-iterator-sections" title="gnome_config_init_iterator_sections()">gnome_config_init_iterator_sections</a> (path)
107
109
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-init-iterator-sections" title="gnome_config_private_init_iterator_sections()">gnome_config_private_init_iterator_sections</a>(path)
108
 
void*               <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()">gnome_config_iterator_next</a>          (void *iterator_handle,
 
110
void *              <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()">gnome_config_iterator_next</a>          (void *iterator_handle,
109
111
                                                         char **key,
110
112
                                                         char **value);
111
113
 
112
114
void                <a class="link" href="libgnome-gnome-config.html#gnome-config-drop-all" title="gnome_config_drop_all ()">gnome_config_drop_all</a>               (void);
113
 
<a
114
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
115
 
>gboolean</a>            <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()">gnome_config_sync</a>                   (void);
 
115
gboolean            <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()">gnome_config_sync</a>                   (void);
116
116
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-sync-file" title="gnome_config_sync_file()">gnome_config_sync_file</a>              (path)
117
117
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-sync-file" title="gnome_config_private_sync_file()">gnome_config_private_sync_file</a>      (path)
118
118
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-drop-file" title="gnome_config_drop_file()">gnome_config_drop_file</a>              (path)
147
147
        their configuration requirements.
148
148
        </p>
149
149
<p>
150
 
        The gnome-config module exists for applications that 
 
150
        The gnome-config module exists for applications that
151
151
                </p>
152
152
<div class="itemizedlist"><ul type="disc">
153
153
<li><p>need to provide a backwards-compatible
274
274
</div>
275
275
<p>
276
276
Retrieves the value of a configuration item as a string. This value should
277
 
be freed with <a
278
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
279
 
><code class="function">g_free()</code></a> when no longer needed.</p>
 
277
be freed with <code class="function">g_free()</code> when no longer needed.</p>
280
278
<p>
281
 
 
282
279
</p>
283
280
<div class="variablelist"><table border="0">
284
281
<col align="left" valign="top">
306
303
</div>
307
304
<p>
308
305
Retrieves the value of a configuration item as a string. This value should
309
 
be freed with <a
310
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
311
 
><code class="function">g_free()</code></a> when no longer needed.</p>
 
306
be freed with <code class="function">g_free()</code> when no longer needed.</p>
312
307
<p>
313
 
 
314
308
</p>
315
309
<div class="variablelist"><table border="0">
316
310
<col align="left" valign="top">
345
339
</div>
346
340
<p>
347
341
Retrieves the value of a configuration item as a string appropriate for the
348
 
current language. The returned value should be freed with <a
349
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
350
 
><code class="function">g_free()</code></a> when no
 
342
current language. The returned value should be freed with <code class="function">g_free()</code> when no
351
343
longer needed.</p>
352
344
<p>
353
 
 
354
345
</p>
355
346
<div class="variablelist"><table border="0">
356
347
<col align="left" valign="top">
378
369
</div>
379
370
<p>
380
371
Retrieves the value of a configuration item as a string appropriate for the
381
 
current language. The returned value should be freed with <a
382
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
383
 
><code class="function">g_free()</code></a> when no
 
372
current language. The returned value should be freed with <code class="function">g_free()</code> when no
384
373
longer needed.</p>
385
374
<p>
386
 
 
387
375
</p>
388
376
<div class="variablelist"><table border="0">
389
377
<col align="left" valign="top">
419
407
<p>
420
408
Retrieves the value of a configuration item from the user's private
421
409
configuration directory as a string. This value should be freed with
422
 
<a
423
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
424
 
><code class="function">g_free()</code></a> when no longer needed.</p>
 
410
<code class="function">g_free()</code> when no longer needed.</p>
425
411
<p>
426
 
 
427
412
</p>
428
413
<div class="variablelist"><table border="0">
429
414
<col align="left" valign="top">
452
437
<p>
453
438
Retrieves the value of a configuration item from the user's private
454
439
configuration directory as a string. This value should be freed with
455
 
<a
456
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
457
 
><code class="function">g_free()</code></a> when no longer needed.</p>
 
440
<code class="function">g_free()</code> when no longer needed.</p>
458
441
<p>
459
 
 
460
442
</p>
461
443
<div class="variablelist"><table border="0">
462
444
<col align="left" valign="top">
491
473
</div>
492
474
<p>
493
475
Retrieves the value of a configuration item as a string appropriate for the
494
 
current language. The returned value should be freed with <a
495
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
496
 
><code class="function">g_free()</code></a> when no
 
476
current language. The returned value should be freed with <code class="function">g_free()</code> when no
497
477
longer needed.  The item is retrieved from the user's private configuration
498
478
storage area.</p>
499
479
<p>
500
 
 
501
480
</p>
502
481
<div class="variablelist"><table border="0">
503
482
<col align="left" valign="top">
525
504
</div>
526
505
<p>
527
506
Retrieves the value of a configuration item as a string appropriate for the
528
 
current language. The returned value should be freed with <a
529
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
530
 
><code class="function">g_free()</code></a> when no
 
507
current language. The returned value should be freed with <code class="function">g_free()</code> when no
531
508
longer needed.  The item is retrieved from the user's private configuration
532
509
storage area.</p>
533
510
<p>
534
 
 
535
511
</p>
536
512
<div class="variablelist"><table border="0">
537
513
<col align="left" valign="top">
568
544
Stores the string value <em class="parameter"><code>new_value</code></em> in the file/section/key
569
545
defined by the <em class="parameter"><code>path</code></em>.</p>
570
546
<p>
571
 
 
572
547
</p>
573
548
<div class="variablelist"><table border="0">
574
549
<col align="left" valign="top">
599
574
by the <em class="parameter"><code>path</code></em> on the proper section for the current language set by
600
575
by the user.</p>
601
576
<p>
602
 
 
603
577
</p>
604
578
<div class="variablelist"><table border="0">
605
579
<col align="left" valign="top">
630
604
defined by the <em class="parameter"><code>path</code></em>. The configuration value is stored in the user's
631
605
private storage area.</p>
632
606
<p>
633
 
 
634
607
</p>
635
608
<div class="variablelist"><table border="0">
636
609
<col align="left" valign="top">
661
634
<em class="parameter"><code>path</code></em> on the proper section for the current language set by by the user.
662
635
The configuration value is stored in the user's private storage area.</p>
663
636
<p>
664
 
 
665
637
</p>
666
638
<div class="variablelist"><table border="0">
667
639
<col align="left" valign="top">
690
662
<p>
691
663
Retrieves an integer value configuration item.</p>
692
664
<p>
693
 
 
694
665
</p>
695
666
<div class="variablelist"><table border="0">
696
667
<col align="left" valign="top">
719
690
<p>
720
691
Retrieves an integer value configuration item.</p>
721
692
<p>
722
 
 
723
693
</p>
724
694
<div class="variablelist"><table border="0">
725
695
<col align="left" valign="top">
756
726
Retrieves a configuration item as an int from the user's private
757
727
configuration storage area.</p>
758
728
<p>
759
 
 
760
729
</p>
761
730
<div class="variablelist"><table border="0">
762
731
<col align="left" valign="top">
786
755
Retrieves a configuration item as an int from the user's private
787
756
configuration storage area.</p>
788
757
<p>
789
 
 
790
758
</p>
791
759
<div class="variablelist"><table border="0">
792
760
<col align="left" valign="top">
823
791
Stores the integer value <em class="parameter"><code>new_value</code></em> in the file/section/key
824
792
defined by the <em class="parameter"><code>path</code></em>.</p>
825
793
<p>
826
 
 
827
794
</p>
828
795
<div class="variablelist"><table border="0">
829
796
<col align="left" valign="top">
854
821
defined by the <em class="parameter"><code>path</code></em>. The value is stored in the user's private
855
822
configuration storage area.</p>
856
823
<p>
857
 
 
858
824
</p>
859
825
<div class="variablelist"><table border="0">
860
826
<col align="left" valign="top">
883
849
<p>
884
850
Retrieves a floating-point valued configuration item.</p>
885
851
<p>
886
 
 
887
852
</p>
888
853
<div class="variablelist"><table border="0">
889
854
<col align="left" valign="top">
912
877
<p>
913
878
Retrieves a floating-point valued configuration item.</p>
914
879
<p>
915
 
 
916
880
</p>
917
881
<div class="variablelist"><table border="0">
918
882
<col align="left" valign="top">
949
913
Retrieves a configuration item from the user's private configuration storage
950
914
area.</p>
951
915
<p>
952
 
 
953
916
</p>
954
917
<div class="variablelist"><table border="0">
955
918
<col align="left" valign="top">
980
943
Retrieves a configuration item from the user's private configuration storage
981
944
area.</p>
982
945
<p>
983
 
 
984
946
</p>
985
947
<div class="variablelist"><table border="0">
986
948
<col align="left" valign="top">
1017
979
Stores the double value <em class="parameter"><code>new_value</code></em> in the file/section/key
1018
980
defined by the <em class="parameter"><code>path</code></em>.</p>
1019
981
<p>
1020
 
 
1021
982
</p>
1022
983
<div class="variablelist"><table border="0">
1023
984
<col align="left" valign="top">
1048
1009
defined by the <em class="parameter"><code>path</code></em>. The value is stored in the user's private
1049
1010
configuration storage area.</p>
1050
1011
<p>
1051
 
 
1052
1012
</p>
1053
1013
<div class="variablelist"><table border="0">
1054
1014
<col align="left" valign="top">
1077
1037
<p>
1078
1038
Retrieves a boolean configuration value.</p>
1079
1039
<p>
1080
 
 
1081
1040
</p>
1082
1041
<div class="variablelist"><table border="0">
1083
1042
<col align="left" valign="top">
1106
1065
<p>
1107
1066
Retrieves a boolean configuration value.</p>
1108
1067
<p>
1109
 
 
1110
1068
</p>
1111
1069
<div class="variablelist"><table border="0">
1112
1070
<col align="left" valign="top">
1142
1100
<p>
1143
1101
Retrieves the item from the user's private configuration storage area.</p>
1144
1102
<p>
1145
 
 
1146
1103
</p>
1147
1104
<div class="variablelist"><table border="0">
1148
1105
<col align="left" valign="top">
1171
1128
<p>
1172
1129
Retrieves the item from the user's private configuration storage area.</p>
1173
1130
<p>
1174
 
 
1175
1131
</p>
1176
1132
<div class="variablelist"><table border="0">
1177
1133
<col align="left" valign="top">
1208
1164
Stores boolean value <em class="parameter"><code>new_value</code></em> in the file/section/key defined by
1209
1165
<em class="parameter"><code>path</code></em>.</p>
1210
1166
<p>
1211
 
 
1212
1167
</p>
1213
1168
<div class="variablelist"><table border="0">
1214
1169
<col align="left" valign="top">
1238
1193
Stores boolean value <em class="parameter"><code>new_value</code></em> in the file/section/key defined by <em class="parameter"><code>path</code></em>.
1239
1194
The value is stored in the user's private configuration storage area.</p>
1240
1195
<p>
1241
 
 
1242
1196
</p>
1243
1197
<div class="variablelist"><table border="0">
1244
1198
<col align="left" valign="top">
1266
1220
</div>
1267
1221
<p>
1268
1222
Retrieves the value of a configuration item as a string array.
1269
 
The returned vector should be freed with <a
1270
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
1271
 
><code class="function">g_free()</code></a> when no longer needed.</p>
 
1223
The returned vector should be freed with <code class="function">g_free()</code> when no longer needed.</p>
1272
1224
<p>
1273
 
 
1274
1225
</p>
1275
1226
<div class="variablelist"><table border="0">
1276
1227
<col align="left" valign="top">
1303
1254
</div>
1304
1255
<p>
1305
1256
Retrieves the value of a configuration item as a string array.
1306
 
The returned vector should be freed with <a
1307
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
1308
 
><code class="function">g_free()</code></a> when no longer needed.</p>
 
1257
The returned vector should be freed with <code class="function">g_free()</code> when no longer needed.</p>
1309
1258
<p>
1310
 
 
1311
1259
</p>
1312
1260
<div class="variablelist"><table border="0">
1313
1261
<col align="left" valign="top">
1346
1294
</div>
1347
1295
<p>
1348
1296
Retrieves the value of a configuration item as a string array.
1349
 
The returned vector should be freed with <a
1350
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
1351
 
><code class="function">g_free()</code></a> when no longer needed. The
 
1297
The returned vector should be freed with <code class="function">g_free()</code> when no longer needed. The
1352
1298
configuration value is retrieved from the user's private configuration
1353
1299
storage area.</p>
1354
1300
<p>
1355
 
 
1356
1301
</p>
1357
1302
<div class="variablelist"><table border="0">
1358
1303
<col align="left" valign="top">
1385
1330
</div>
1386
1331
<p>
1387
1332
Retrieves the value of a configuration item as a string array.
1388
 
The returned vector should be freed with <a
1389
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
1390
 
><code class="function">g_free()</code></a> when no longer needed. The
 
1333
The returned vector should be freed with <code class="function">g_free()</code> when no longer needed. The
1391
1334
configuration value is retrieved from the user's private configuration
1392
1335
storage area.</p>
1393
1336
<p>
1394
 
 
1395
1337
</p>
1396
1338
<div class="variablelist"><table border="0">
1397
1339
<col align="left" valign="top">
1432
1374
Stores vector <em class="parameter"><code>argv</code></em> in the file/section/key defined by
1433
1375
<em class="parameter"><code>path</code></em>.</p>
1434
1376
<p>
1435
 
 
1436
1377
</p>
1437
1378
<div class="variablelist"><table border="0">
1438
1379
<col align="left" valign="top">
1467
1408
Stores vector <em class="parameter"><code>argv</code></em> in the file/section/key defined by <em class="parameter"><code>path</code></em>. The
1468
1409
configuration value is set in the user's private storage area.</p>
1469
1410
<p>
1470
 
 
1471
1411
</p>
1472
1412
<div class="variablelist"><table border="0">
1473
1413
<col align="left" valign="top">
1493
1433
<hr>
1494
1434
<div class="refsect2" lang="en">
1495
1435
<a name="gnome-config-assemble-vector"></a><h3>gnome_config_assemble_vector ()</h3>
1496
 
<pre class="programlisting">char*               gnome_config_assemble_vector        (int argc,
 
1436
<pre class="programlisting">char *              gnome_config_assemble_vector        (int argc,
1497
1437
                                                         const char *const argv[]);</pre>
1498
1438
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1499
1439
<h3 class="title">Warning</h3>
1501
1441
</div>
1502
1442
<p>
1503
1443
This routine returns the the strings in the array contactenated by
1504
 
spaces. The return value should be freed with <a
1505
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
1506
 
><code class="function">g_free()</code></a> when it is no longer
 
1444
spaces. The return value should be freed with <code class="function">g_free()</code> when it is no longer
1507
1445
required.</p>
1508
1446
<p>
1509
 
 
1510
1447
</p>
1511
1448
<div class="variablelist"><table border="0">
1512
1449
<col align="left" valign="top">
1541
1478
Queries the gnome configuration file for the presence
1542
1479
of the section specified in <em class="parameter"><code>path</code></em>.</p>
1543
1480
<p>
1544
 
 
1545
1481
</p>
1546
1482
<div class="variablelist"><table border="0">
1547
1483
<col align="left" valign="top">
1553
1489
</tr>
1554
1490
<tr>
1555
1491
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1556
 
<td> <a
1557
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
1558
 
><code class="literal">TRUE</code></a> if the section exists, <a
1559
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1560
 
><code class="literal">FALSE</code></a> otherwise.
 
1492
<td> <code class="literal">TRUE</code> if the section exists, <code class="literal">FALSE</code> otherwise.
1561
1493
</td>
1562
1494
</tr>
1563
1495
</tbody>
1575
1507
Queries the private gnome configuration file for the presence
1576
1508
of the section specified in <em class="parameter"><code>path</code></em>.</p>
1577
1509
<p>
1578
 
 
1579
1510
</p>
1580
1511
<div class="variablelist"><table border="0">
1581
1512
<col align="left" valign="top">
1587
1518
</tr>
1588
1519
<tr>
1589
1520
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1590
 
<td> <a
1591
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
1592
 
><code class="literal">TRUE</code></a> if the section exists, <a
1593
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1594
 
><code class="literal">FALSE</code></a> otherwise.
 
1521
<td> <code class="literal">TRUE</code> if the section exists, <code class="literal">FALSE</code> otherwise.
1595
1522
</td>
1596
1523
</tr>
1597
1524
</tbody>
1611
1538
file.  <em class="parameter"><code>path</code></em> must refer to a section.  The returned value
1612
1539
can be used as an iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.</p>
1613
1540
<p>
1614
 
 
1615
1541
</p>
1616
1542
<div class="variablelist"><table border="0">
1617
1543
<col align="left" valign="top">
1643
1569
file.  <em class="parameter"><code>path</code></em> must refer to a section.  The returned value
1644
1570
can be used as an iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.</p>
1645
1571
<p>
1646
 
 
1647
1572
</p>
1648
1573
<div class="variablelist"><table border="0">
1649
1574
<col align="left" valign="top">
1675
1600
gnome configuration file.  The returned value can be used as an
1676
1601
iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.</p>
1677
1602
<p>
1678
 
 
1679
1603
</p>
1680
1604
<div class="variablelist"><table border="0">
1681
1605
<col align="left" valign="top">
1707
1631
gnome configuration file.  The returned value can be used as an
1708
1632
iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.</p>
1709
1633
<p>
1710
 
 
1711
1634
</p>
1712
1635
<div class="variablelist"><table border="0">
1713
1636
<col align="left" valign="top">
1728
1651
<hr>
1729
1652
<div class="refsect2" lang="en">
1730
1653
<a name="gnome-config-iterator-next"></a><h3>gnome_config_iterator_next ()</h3>
1731
 
<pre class="programlisting">void*               gnome_config_iterator_next          (void *iterator_handle,
 
1654
<pre class="programlisting">void *              gnome_config_iterator_next          (void *iterator_handle,
1732
1655
                                                         char **key,
1733
1656
                                                         char **value);</pre>
1734
1657
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1736
1659
<p><code class="literal">gnome_config_iterator_next</code> is deprecated and should not be used in newly-written code.</p>
1737
1660
</div>
1738
1661
<p>
1739
 
If <em class="parameter"><code>key</code></em> is non-NULL, then <em class="parameter"><code>key</code></em> will point to a <a
1740
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-malloc"
1741
 
><code class="function">g_malloc()</code></a>ed region that
 
1662
If <em class="parameter"><code>key</code></em> is non-NULL, then <em class="parameter"><code>key</code></em> will point to a <code class="function">g_malloc()</code>ed region that
1742
1663
holds the key.
1743
1664
</p>
1744
1665
<p>
1745
 
If <em class="parameter"><code>value</code></em> is non-NULL, then <em class="parameter"><code>value</code></em> will point to a <a
1746
 
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-malloc"
1747
 
><code class="function">g_malloc()</code></a>ed region that
 
1666
If <em class="parameter"><code>value</code></em> is non-NULL, then <em class="parameter"><code>value</code></em> will point to a <code class="function">g_malloc()</code>ed region that
1748
1667
holds the key.</p>
1749
1668
<p>
1750
 
 
1751
1669
</p>
1752
1670
<div class="variablelist"><table border="0">
1753
1671
<col align="left" valign="top">
1771
1689
<tr>
1772
1690
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1773
1691
<td>
1774
 
 
1775
 
 
1776
1692
</td>
1777
1693
</tr>
1778
1694
</tbody>
1791
1707
gnome config. Any pending information that has not been
1792
1708
written to disk is discarded.</p>
1793
1709
<p>
1794
 
 
1795
1710
</p>
1796
1711
</div>
1797
1712
<hr>
1798
1713
<div class="refsect2" lang="en">
1799
1714
<a name="gnome-config-sync"></a><h3>gnome_config_sync ()</h3>
1800
 
<pre class="programlisting"><a
1801
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
1802
 
>gboolean</a>            gnome_config_sync                   (void);</pre>
 
1715
<pre class="programlisting">gboolean            gnome_config_sync                   (void);</pre>
1803
1716
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1804
1717
<h3 class="title">Warning</h3>
1805
1718
<p><code class="literal">gnome_config_sync</code> is deprecated and should not be used in newly-written code.</p>
1812
1725
Note: the gnome-config code does not write anything to the
1813
1726
configuration files until this routine is actually invoked.</p>
1814
1727
<p>
1815
 
 
1816
1728
</p>
1817
1729
<div class="variablelist"><table border="0">
1818
1730
<col align="left" valign="top">
1819
1731
<tbody><tr>
1820
1732
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1821
 
<td> <a
1822
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
1823
 
><code class="literal">TRUE</code></a> if everything went well. <a
1824
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1825
 
><code class="literal">FALSE</code></a> if any file
 
1733
<td> <code class="literal">TRUE</code> if everything went well. <code class="literal">FALSE</code> if any file
1826
1734
could not be written to disk.
1827
1735
</td>
1828
1736
</tr></tbody>
1845
1753
configuration files until this routine or <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a>
1846
1754
is actually invoked.</p>
1847
1755
<p>
1848
 
 
1849
1756
</p>
1850
1757
<div class="variablelist"><table border="0">
1851
1758
<col align="left" valign="top">
1857
1764
</tr>
1858
1765
<tr>
1859
1766
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1860
 
<td> <a
1861
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
1862
 
><code class="literal">TRUE</code></a> if everything went well, <a
1863
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1864
 
><code class="literal">FALSE</code></a> if the file
1865
 
could not be written to for some reason.  <a
1866
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1867
 
><code class="literal">FALSE</code></a> is only returned
 
1767
<td> <code class="literal">TRUE</code> if everything went well, <code class="literal">FALSE</code> if the file
 
1768
could not be written to for some reason.  <code class="literal">FALSE</code> is only returned
1868
1769
when a write was actually attempted and failed.
1869
1770
</td>
1870
1771
</tr>
1888
1789
configuration files until this routine or <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a>
1889
1790
is actually invoked.</p>
1890
1791
<p>
1891
 
 
1892
1792
</p>
1893
1793
<div class="variablelist"><table border="0">
1894
1794
<col align="left" valign="top">
1900
1800
</tr>
1901
1801
<tr>
1902
1802
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1903
 
<td> <a
1904
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
1905
 
><code class="literal">TRUE</code></a> if everything went well, <a
1906
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1907
 
><code class="literal">FALSE</code></a> if the file
1908
 
could not be written to for some reason.  <a
1909
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1910
 
><code class="literal">FALSE</code></a> is only returned
 
1803
<td> <code class="literal">TRUE</code> if everything went well, <code class="literal">FALSE</code> if the file
 
1804
could not be written to for some reason.  <code class="literal">FALSE</code> is only returned
1911
1805
when a write was actually attempted and failed.
1912
1806
</td>
1913
1807
</tr>
1927
1821
the configuration file in <em class="parameter"><code>path</code></em>.  Changes will take place after
1928
1822
<a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked</p>
1929
1823
<p>
1930
 
 
1931
1824
</p>
1932
1825
<div class="variablelist"><table border="0">
1933
1826
<col align="left" valign="top">
1950
1843
Releases any memory resources that were allocated from accessing the
1951
1844
private configuration file in <em class="parameter"><code>path</code></em>.</p>
1952
1845
<p>
1953
 
 
1954
1846
</p>
1955
1847
<div class="variablelist"><table border="0">
1956
1848
<col align="left" valign="top">
1976
1868
<p>
1977
1869
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.</p>
1978
1870
<p>
1979
 
 
1980
1871
</p>
1981
1872
<div class="variablelist"><table border="0">
1982
1873
<col align="left" valign="top">
2002
1893
<p>
2003
1894
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.</p>
2004
1895
<p>
2005
 
 
2006
1896
</p>
2007
1897
<div class="variablelist"><table border="0">
2008
1898
<col align="left" valign="top">
2026
1916
configuration information.  Changes will only take place
2027
1917
after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.</p>
2028
1918
<p>
2029
 
 
2030
1919
</p>
2031
1920
<div class="variablelist"><table border="0">
2032
1921
<col align="left" valign="top">
2050
1939
configuration information.  Changes will only take place after
2051
1940
<a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.</p>
2052
1941
<p>
2053
 
 
2054
1942
</p>
2055
1943
<div class="variablelist"><table border="0">
2056
1944
<col align="left" valign="top">
2075
1963
<p>
2076
1964
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.</p>
2077
1965
<p>
2078
 
 
2079
1966
</p>
2080
1967
<div class="variablelist"><table border="0">
2081
1968
<col align="left" valign="top">
2101
1988
<p>
2102
1989
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.</p>
2103
1990
<p>
2104
 
 
2105
1991
</p>
2106
1992
<div class="variablelist"><table border="0">
2107
1993
<col align="left" valign="top">
2135
2021
<tr>
2136
2022
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2137
2023
<td>An absolute path to the config file.
2138
 
 
2139
 
 
2140
2024
</td>
2141
2025
</tr>
2142
2026
</tbody>
2166
2050
<tr>
2167
2051
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2168
2052
<td>An absolute path to the config file.
2169
 
 
2170
 
 
2171
2053
</td>
2172
2054
</tr>
2173
2055
</tbody>
2193
2075
any gnome-configuration access, since the application might
2194
2076
be using their own prefix.</p>
2195
2077
<p>
2196
 
 
2197
2078
</p>
2198
2079
<div class="variablelist"><table border="0">
2199
2080
<col align="left" valign="top">
2215
2096
<p>
2216
2097
Call this routine to remove the current configuration prefix from the stack.</p>
2217
2098
<p>
2218
 
 
2219
2099
</p>
2220
2100
</div>
2221
2101
<hr>
2233
2113
breaks the string on spaces except if the space is escaped with a
2234
2114
backslash.</p>
2235
2115
<p>
2236
 
 
2237
2116
</p>
2238
2117
<div class="variablelist"><table border="0">
2239
2118
<col align="left" valign="top">
2260
2139
</div>
2261
2140
<div class="footer">
2262
2141
<hr>
2263
 
          Generated by GTK-Doc V1.10</div>
 
2142
          Generated by GTK-Doc V1.12</div>
2264
2143
</body>
2265
2144
</html>