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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
<refentry id="gsf-Output-to-unstructured-files">
<refmeta>
<refentrytitle role="top_of_page">Output to unstructured files</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GSF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Output to unstructured files</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GsfOutput"/>
<synopsis>
<link linkend="GsfOutput-struct">GsfOutput</link>;
<link linkend="gsf-off-t">gsf_off_t</link> <link linkend="gsf-output-size">gsf_output_size</link> (<link linkend="GsfOutput">GsfOutput</link> *output);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-close">gsf_output_close</link> (<link linkend="GsfOutput">GsfOutput</link> *output);
<link linkend="gsf-off-t">gsf_off_t</link> <link linkend="gsf-output-tell">gsf_output_tell</link> (<link linkend="GsfOutput">GsfOutput</link> *output);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-seek">gsf_output_seek</link> (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="gsf-off-t">gsf_off_t</link> offset,
<link linkend="GSeekType">GSeekType</link> whence);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-write">gsf_output_write</link> (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="size-t">size_t</link> num_bytes,
<link linkend="guint8">guint8</link> const *data);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-puts">gsf_output_puts</link> (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *line);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-printf">gsf_output_printf</link> (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *format,
...);
<link linkend="gsf-off-t">gsf_off_t</link> <link linkend="gsf-output-vprintf">gsf_output_vprintf</link> (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *format,
<link linkend="va-list">va_list</link> args);
<link linkend="GsfOutfile">GsfOutfile</link>* <link linkend="gsf-output-container">gsf_output_container</link> (<link linkend="GsfOutput">GsfOutput</link> const *output);
<link linkend="char">char</link>const * <link linkend="gsf-output-name">gsf_output_name</link> (<link linkend="GsfOutput">GsfOutput</link> const *output);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-set-name-from-filename">gsf_output_set_name_from_filename</link> (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *filename);
<link linkend="GQuark">GQuark</link> <link linkend="gsf-output-error-id">gsf_output_error_id</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-set-error">gsf_output_set_error</link> (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="gint">gint</link> code,
<link linkend="char">char</link> const *format,
...);
<link linkend="GError">GError</link>const * <link linkend="gsf-output-error">gsf_output_error</link> (<link linkend="GsfOutput">GsfOutput</link> const *output);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-is-closed">gsf_output_is_closed</link> (<link linkend="GsfOutput">GsfOutput</link> const *output);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-wrap">gsf_output_wrap</link> (<link linkend="GObject">GObject</link> *wrapper,
<link linkend="GsfOutput">GsfOutput</link> *wrapee);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-output-unwrap">gsf_output_unwrap</link> (<link linkend="GObject">GObject</link> *wrapper,
<link linkend="GsfOutput">GsfOutput</link> *wrapee);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GsfOutput
+----<link linkend="GsfOutfile">GsfOutfile</link>
+----<link linkend="GsfOutputBzip">GsfOutputBzip</link>
+----<link linkend="GsfOutputCsv">GsfOutputCsv</link>
+----<link linkend="GsfOutputGZip">GsfOutputGZip</link>
+----<link linkend="GsfOutputIconv">GsfOutputIconv</link>
+----<link linkend="GsfOutputIOChannel">GsfOutputIOChannel</link>
+----<link linkend="GsfOutputMemory">GsfOutputMemory</link>
+----<link linkend="GsfOutputStdio">GsfOutputStdio</link>
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GsfOutput--is-closed">is-closed</link>" <link linkend="gboolean">gboolean</link> : Read
"<link linkend="GsfOutput--name">name</link>" <link linkend="gchararray">gchararray</link> : Read
"<link linkend="GsfOutput--position">position</link>" <link linkend="gint64">gint64</link> : Read
"<link linkend="GsfOutput--size">size</link>" <link linkend="gint64">gint64</link> : Read
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GsfOutput-struct" role="struct"/>GsfOutput</title>
<indexterm><primary>GsfOutput</primary></indexterm><programlisting>typedef struct _GsfOutput GsfOutput;</programlisting>
<para>
Class representing an output stream, counterpart to <link linkend="GsfInput"><type>GsfInput</type></link>.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-output-size" role="function"/>gsf_output_size ()</title>
<indexterm><primary>gsf_output_size</primary></indexterm><programlisting><link linkend="gsf-off-t">gsf_off_t</link> gsf_output_size (<link linkend="GsfOutput">GsfOutput</link> *output);</programlisting>
<para>
Determine the size of the output stream <parameter>output</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the size of the output, or -1 if it does not have a size.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-close" role="function"/>gsf_output_close ()</title>
<indexterm><primary>gsf_output_close</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_close (<link linkend="GsfOutput">GsfOutput</link> *output);</programlisting>
<para>
Close a stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-tell" role="function"/>gsf_output_tell ()</title>
<indexterm><primary>gsf_output_tell</primary></indexterm><programlisting><link linkend="gsf-off-t">gsf_off_t</link> gsf_output_tell (<link linkend="GsfOutput">GsfOutput</link> *output);</programlisting>
<para>
Tell the current position in <parameter>output</parameter>, similar to
<citerefentry><refentrytitle>ftell</refentrytitle>
<manvolnum>3</manvolnum></citerefentry>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current position in the file
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-seek" role="function"/>gsf_output_seek ()</title>
<indexterm><primary>gsf_output_seek</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_seek (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="gsf-off-t">gsf_off_t</link> offset,
<link linkend="GSeekType">GSeekType</link> whence);</programlisting>
<para>
Reposition in output stream <parameter>output</parameter>. <parameter>whence</parameter> specifies what the offset is
relative to: the beginning of the stream (<link linkend="G-SEEK-SET:CAPS"><literal>G_SEEK_SET</literal></link>), current position in
the stream (<link linkend="G-SEEK-CUR:CAPS"><literal>G_SEEK_CUR</literal></link>) or the end of the stream (<link linkend="G-SEEK-END:CAPS"><literal>G_SEEK_END</literal></link>).
This function is similar to
<citerefentry><refentrytitle>fseek</refentrytitle>
<manvolnum>3</manvolnum></citerefentry>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> Relative amount to reposition
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>whence</parameter> :</term>
<listitem><simpara> What the offset is relative to.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-write" role="function"/>gsf_output_write ()</title>
<indexterm><primary>gsf_output_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_write (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="size-t">size_t</link> num_bytes,
<link linkend="guint8">guint8</link> const *data);</programlisting>
<para>
Write <parameter>num_bytes</parameter> of <parameter>data</parameter> to <parameter>output</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> Output stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_bytes</parameter> :</term>
<listitem><simpara> Number of bytes to write
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> Data to write.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-puts" role="function"/>gsf_output_puts ()</title>
<indexterm><primary>gsf_output_puts</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_puts (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *line);</programlisting>
<para>
Like fputs, this assumes that the line already ends with a newline</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> A <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>line</parameter> :</term>
<listitem><simpara> <link linkend="null"><literal>null</literal></link> terminated string to write
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-printf" role="function"/>gsf_output_printf ()</title>
<indexterm><primary>gsf_output_printf</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_printf (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *format,
...);</programlisting>
<para>
Output <parameter>Varargs</parameter> to <parameter>output</parameter> using the format string <parameter>format</parameter>, similar to
<citerefentry><refentrytitle>printf</refentrytitle>
<manvolnum>3</manvolnum></citerefentry>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> A <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> The printf-style format string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> the arguments for <parameter>format</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-vprintf" role="function"/>gsf_output_vprintf ()</title>
<indexterm><primary>gsf_output_vprintf</primary></indexterm><programlisting><link linkend="gsf-off-t">gsf_off_t</link> gsf_output_vprintf (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *format,
<link linkend="va-list">va_list</link> args);</programlisting>
<para>
Output <parameter>args</parameter> to <parameter>output</parameter> using the format string <parameter>format</parameter>, similar to
<citerefentry><refentrytitle>vprintf</refentrytitle>
<manvolnum>3</manvolnum></citerefentry>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> A <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> The printf-style format string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter> :</term>
<listitem><simpara> the arguments for <parameter>format</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> number of bytes printed, a negative value if not successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-container" role="function"/>gsf_output_container ()</title>
<indexterm><primary>gsf_output_container</primary></indexterm><programlisting><link linkend="GsfOutfile">GsfOutfile</link>* gsf_output_container (<link linkend="GsfOutput">GsfOutput</link> const *output);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> but does not add a reference to <parameter>output</parameter>'s container.
Potentially <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-name" role="function"/>gsf_output_name ()</title>
<indexterm><primary>gsf_output_name</primary></indexterm><programlisting><link linkend="char">char</link>const * gsf_output_name (<link linkend="GsfOutput">GsfOutput</link> const *output);</programlisting>
<para>
Give the name of <parameter>output</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>output</parameter>'s name in utf8 form, DO NOT FREE THIS STRING
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-set-name-from-filename" role="function"/>gsf_output_set_name_from_filename ()</title>
<indexterm><primary>gsf_output_set_name_from_filename</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_set_name_from_filename (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="char">char</link> const *filename);</programlisting>
<para>
<note>This is a utility routine that should only be used by derived
outputs.</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> the output stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> the (fs-sys encoded) filename
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the assignment was ok.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-error-id" role="function"/>gsf_output_error_id ()</title>
<indexterm><primary>gsf_output_error_id</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> gsf_output_error_id (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-set-error" role="function"/>gsf_output_set_error ()</title>
<indexterm><primary>gsf_output_set_error</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_set_error (<link linkend="GsfOutput">GsfOutput</link> *output,
<link linkend="gint">gint</link> code,
<link linkend="char">char</link> const *format,
...);</programlisting>
<para>
<note>This is a utility routine that should only be used by derived
outputs.</note></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>code</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Always returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to facilitate its use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-error" role="function"/>gsf_output_error ()</title>
<indexterm><primary>gsf_output_error</primary></indexterm><programlisting><link linkend="GError">GError</link>const * gsf_output_error (<link linkend="GsfOutput">GsfOutput</link> const *output);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the last error logged on the output, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-is-closed" role="function"/>gsf_output_is_closed ()</title>
<indexterm><primary>gsf_output_is_closed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_is_closed (<link linkend="GsfOutput">GsfOutput</link> const *output);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>output</parameter> has already been closed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-wrap" role="function"/>gsf_output_wrap ()</title>
<indexterm><primary>gsf_output_wrap</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_wrap (<link linkend="GObject">GObject</link> *wrapper,
<link linkend="GsfOutput">GsfOutput</link> *wrapee);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>wrapper</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wrapee</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the wrapping succeeded.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-output-unwrap" role="function"/>gsf_output_unwrap ()</title>
<indexterm><primary>gsf_output_unwrap</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_output_unwrap (<link linkend="GObject">GObject</link> *wrapper,
<link linkend="GsfOutput">GsfOutput</link> *wrapee);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>wrapper</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wrapee</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the unwrapping succeeded.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GsfOutput--is-closed"/>The "<literal>is-closed</literal>" property</title>
<indexterm><primary>GsfOutput:is-closed</primary></indexterm><programlisting> "is-closed" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>Whether the Output is Closed.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="GsfOutput--name"/>The "<literal>name</literal>" property</title>
<indexterm><primary>GsfOutput:name</primary></indexterm><programlisting> "name" <link linkend="gchararray">gchararray</link> : Read</programlisting>
<para>The Output's Name.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GsfOutput--position"/>The "<literal>position</literal>" property</title>
<indexterm><primary>GsfOutput:position</primary></indexterm><programlisting> "position" <link linkend="gint64">gint64</link> : Read</programlisting>
<para>The Output's Current Position.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GsfOutput--size"/>The "<literal>size</literal>" property</title>
<indexterm><primary>GsfOutput:size</primary></indexterm><programlisting> "size" <link linkend="gint64">gint64</link> : Read</programlisting>
<para>The Output's Size.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
</refsect1>
</refentry>
|
