1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimpconfig-GimpConfigWriter">
<refmeta>
<refentrytitle role="top_of_page" id="libgimpconfig-GimpConfigWriter.top_of_page">gimpconfigwriter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPCONFIG Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpconfigwriter</refname>
<refpurpose>Functions for writing config info to a file for libgimpconfig.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libgimpconfig-GimpConfigWriter.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpConfigWriter">GimpConfigWriter</link>;
<link linkend="GimpConfigWriter">GimpConfigWriter</link>* <link linkend="gimp-config-writer-new-file">gimp_config_writer_new_file</link> (const <link linkend="gchar">gchar</link> *filename,
<link linkend="gboolean">gboolean</link> atomic,
const <link linkend="gchar">gchar</link> *header,
<link linkend="GError">GError</link> **error);
<link linkend="GimpConfigWriter">GimpConfigWriter</link>* <link linkend="gimp-config-writer-new-fd">gimp_config_writer_new_fd</link> (<link linkend="gint">gint</link> fd);
<link linkend="GimpConfigWriter">GimpConfigWriter</link>* <link linkend="gimp-config-writer-new-string">gimp_config_writer_new_string</link> (<link linkend="GString">GString</link> *string);
<link linkend="void">void</link> <link linkend="gimp-config-writer-open">gimp_config_writer_open</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *name);
<link linkend="void">void</link> <link linkend="gimp-config-writer-comment-mode">gimp_config_writer_comment_mode</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
<link linkend="gboolean">gboolean</link> enable);
<link linkend="void">void</link> <link linkend="gimp-config-writer-print">gimp_config_writer_print</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *string,
<link linkend="gint">gint</link> len);
<link linkend="void">void</link> <link linkend="gimp-config-writer-printf">gimp_config_writer_printf</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *format,
...);
<link linkend="void">void</link> <link linkend="gimp-config-writer-identifier">gimp_config_writer_identifier</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *identifier);
<link linkend="void">void</link> <link linkend="gimp-config-writer-string">gimp_config_writer_string</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *string);
<link linkend="void">void</link> <link linkend="gimp-config-writer-data">gimp_config_writer_data</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
<link linkend="gint">gint</link> length,
const <link linkend="guint8">guint8</link> *data);
<link linkend="void">void</link> <link linkend="gimp-config-writer-comment">gimp_config_writer_comment</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *comment);
<link linkend="void">void</link> <link linkend="gimp-config-writer-linefeed">gimp_config_writer_linefeed</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);
<link linkend="void">void</link> <link linkend="gimp-config-writer-revert">gimp_config_writer_revert</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);
<link linkend="void">void</link> <link linkend="gimp-config-writer-close">gimp_config_writer_close</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-writer-finish">gimp_config_writer_finish</link> (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *footer,
<link linkend="GError">GError</link> **error);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libgimpconfig-GimpConfigWriter.description" role="desc">
<title role="desc.title">Description</title>
<para>
Functions for writing config info to a file for libgimpconfig.
</para>
</refsect1>
<refsect1 id="libgimpconfig-GimpConfigWriter.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpConfigWriter" role="struct">
<title>GimpConfigWriter</title>
<indexterm zone="GimpConfigWriter"><primary>GimpConfigWriter</primary></indexterm><programlisting>typedef struct _GimpConfigWriter GimpConfigWriter;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-config-writer-new-file" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_new_file ()</title>
<indexterm zone="gimp-config-writer-new-file" role="GIMP 2.4"><primary>gimp_config_writer_new_file</primary></indexterm><programlisting><link linkend="GimpConfigWriter">GimpConfigWriter</link>* gimp_config_writer_new_file (const <link linkend="gchar">gchar</link> *filename,
<link linkend="gboolean">gboolean</link> atomic,
const <link linkend="gchar">gchar</link> *header,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link> and sets it up to write to
<parameter>filename</parameter>. If <parameter>atomic</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, a temporary file is used to avoid
possible race conditions. The temporary file is then moved to
<parameter>filename</parameter> when the writer is closed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> a filename
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>atomic</parameter> :</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> the file is written atomically
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter> :</term>
<listitem><simpara> text to include as comment at the top of the file
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> in case of an error
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-new-fd" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_new_fd ()</title>
<indexterm zone="gimp-config-writer-new-fd" role="GIMP 2.4"><primary>gimp_config_writer_new_fd</primary></indexterm><programlisting><link linkend="GimpConfigWriter">GimpConfigWriter</link>* gimp_config_writer_new_fd (<link linkend="gint">gint</link> fd);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fd</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> in case of an error
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-new-string" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_new_string ()</title>
<indexterm zone="gimp-config-writer-new-string" role="GIMP 2.4"><primary>gimp_config_writer_new_string</primary></indexterm><programlisting><link linkend="GimpConfigWriter">GimpConfigWriter</link>* gimp_config_writer_new_string (<link linkend="GString">GString</link> *string);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> in case of an error
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-open" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_open ()</title>
<indexterm zone="gimp-config-writer-open" role="GIMP 2.4"><primary>gimp_config_writer_open</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_open (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
This function writes the opening parenthese followed by <parameter>name</parameter>.
It also increases the indentation level and sets a mark that
can be used by <link linkend="gimp-config-writer-revert"><function>gimp_config_writer_revert()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the element to open
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-comment-mode" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_comment_mode ()</title>
<indexterm zone="gimp-config-writer-comment-mode" role="GIMP 2.4"><primary>gimp_config_writer_comment_mode</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_comment_mode (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
<link linkend="gboolean">gboolean</link> enable);</programlisting>
<para>
This function toggles whether the <parameter>writer</parameter> should create commented
or uncommented output. This feature is used to generate the
system-wide installed gimprc that documents the default settings.
</para>
<para>
Since comments have to start at the beginning of a line, this
funtion will insert a newline if necessary.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>enable</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to enable comment mode, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to disable it
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-print" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_print ()</title>
<indexterm zone="gimp-config-writer-print" role="GIMP 2.4"><primary>gimp_config_writer_print</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_print (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *string,
<link linkend="gint">gint</link> len);</programlisting>
<para>
Appends a space followed by <parameter>string</parameter> to the <parameter>writer</parameter>. Note that string
must not contain any special characters that might need to be escaped.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> a string to write
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> number of bytes from <parameter>string</parameter> or -1 if <parameter>string</parameter> is NUL-terminated.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-printf" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_printf ()</title>
<indexterm zone="gimp-config-writer-printf" role="GIMP 2.4"><primary>gimp_config_writer_printf</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_printf (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *format,
...);</programlisting>
<para>
A printf-like function for <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> a format string as described for <link linkend="g-strdup-printf"><function>g_strdup_printf()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> list of arguments according to <parameter>format</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-identifier" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_identifier ()</title>
<indexterm zone="gimp-config-writer-identifier" role="GIMP 2.4"><primary>gimp_config_writer_identifier</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_identifier (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *identifier);</programlisting>
<para>
Writes an identifier to <parameter>writer</parameter>. The <parameter>string</parameter> is *not* quoted and special
characters are *not* escaped.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>identifier</parameter> :</term>
<listitem><simpara> a NUL-terminated string
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-string" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_string ()</title>
<indexterm zone="gimp-config-writer-string" role="GIMP 2.4"><primary>gimp_config_writer_string</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_string (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *string);</programlisting>
<para>
Writes a string value to <parameter>writer</parameter>. The <parameter>string</parameter> is quoted and special
characters are escaped.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> a NUL-terminated string
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-data" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_data ()</title>
<indexterm zone="gimp-config-writer-data" role="GIMP 2.4"><primary>gimp_config_writer_data</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_data (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
<link linkend="gint">gint</link> length,
const <link linkend="guint8">guint8</link> *data);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-comment" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_comment ()</title>
<indexterm zone="gimp-config-writer-comment" role="GIMP 2.4"><primary>gimp_config_writer_comment</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_comment (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *comment);</programlisting>
<para>
Appends the <parameter>comment</parameter> to <parameter>str</parameter> and inserts linebreaks and hash-marks to
format it as a comment. Note that this function does not handle non-ASCII
characters.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>comment</parameter> :</term>
<listitem><simpara> the comment to write (ASCII only)
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-linefeed" role="function">
<title>gimp_config_writer_linefeed ()</title>
<indexterm zone="gimp-config-writer-linefeed"><primary>gimp_config_writer_linefeed</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_linefeed (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-config-writer-revert" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_revert ()</title>
<indexterm zone="gimp-config-writer-revert" role="GIMP 2.4"><primary>gimp_config_writer_revert</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_revert (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);</programlisting>
<para>
Reverts all changes to <parameter>writer</parameter> that were done since the last call
to <link linkend="gimp-config-writer-open"><function>gimp_config_writer_open()</function></link>. This can only work if you didn't call
<link linkend="gimp-config-writer-close"><function>gimp_config_writer_close()</function></link> yet.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-close" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_close ()</title>
<indexterm zone="gimp-config-writer-close" role="GIMP 2.4"><primary>gimp_config_writer_close</primary></indexterm><programlisting><link linkend="void">void</link> gimp_config_writer_close (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);</programlisting>
<para>
Closes an element opened with <link linkend="gimp-config-writer-open"><function>gimp_config_writer_open()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2 id="gimp-config-writer-finish" role="function" condition="since:GIMP 2.4">
<title>gimp_config_writer_finish ()</title>
<indexterm zone="gimp-config-writer-finish" role="GIMP 2.4"><primary>gimp_config_writer_finish</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_writer_finish (<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer,
const <link linkend="gchar">gchar</link> *footer,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
This function finishes the work of <parameter>writer</parameter> and frees it afterwards.
It closes all open elements, appends an optional comment and
releases all resources allocated by <parameter>writer</parameter>. You must not access
the <parameter>writer</parameter> afterwards.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>writer</parameter> :</term>
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>footer</parameter> :</term>
<listitem><simpara> text to include as comment at the bottom of the file
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> return location for possible errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if everything could be successfully written,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
</refsect1>
</refentry>
|
