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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Output to unstructured files</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<link rel="start" href="index.html" title="GSF Reference Manual">
<link rel="up" href="io.html" title="Basic Input/Output">
<link rel="prev" href="gsf-Input-from-unstructured-files.html" title="Input from unstructured files">
<link rel="next" href="sources.html" title="Stream Sources">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="intro.html" title="Part I. GSF: Introduction">
<link rel="part" href="history.html" title="Part II. GSF: History">
<link rel="part" href="dependencies.html" title="Part III. GSF: Dependencies">
<link rel="part" href="gsf-users.html" title="Part IV. Projects using GSF">
<link rel="part" href="api.html" title="Part V. API Reference">
<link rel="chapter" href="io.html" title="Basic Input/Output">
<link rel="chapter" href="sources.html" title="Stream Sources">
<link rel="chapter" href="parsers.html" title="Stream Parsers">
<link rel="chapter" href="misc.html" title="Miscellaneous">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gsf-Input-from-unstructured-files.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="io.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GSF Reference Manual</th>
<td><a accesskey="n" href="sources.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2552724" class="shortcut">Top</a>
 | 
<a href="#id2553396" class="shortcut">Description</a>
 | 
<a href="#id2553223" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2553313" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gsf-Output-to-unstructured-files"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2552724"></a><span class="refentrytitle">Output to unstructured files</span>
</h2>
<p>Output to unstructured files</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GsfOutput"></a><pre class="synopsis">
<a href="gsf-Output-to-unstructured-files.html#GsfOutput-struct">GsfOutput</a>;
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* <a href="gsf-Output-to-unstructured-files.html#gsf-output-container">gsf_output_container</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);
<a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> <a href="gsf-Output-to-unstructured-files.html#gsf-output-size">gsf_output_size</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-close">gsf_output_close</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output);
<a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> <a href="gsf-Output-to-unstructured-files.html#gsf-output-tell">gsf_output_tell</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-seek">gsf_output_seek</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
<a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> offset,
GSeekType whence);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-write">gsf_output_write</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
size_t num_bytes,
guint8 const *data);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-puts">gsf_output_puts</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *line);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-printf">gsf_output_printf</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *format,
...);
<a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> <a href="gsf-Output-to-unstructured-files.html#gsf-output-vprintf">gsf_output_vprintf</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *format,
va_list args);
charconst * <a href="gsf-Output-to-unstructured-files.html#gsf-output-name">gsf_output_name</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-set-name-from-filename">gsf_output_set_name_from_filename</a>
(<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *filename);
GQuark <a href="gsf-Output-to-unstructured-files.html#gsf-output-error-id">gsf_output_error_id</a> (void);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-set-error">gsf_output_set_error</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
gint code,
char const *format,
...);
GErrorconst * <a href="gsf-Output-to-unstructured-files.html#gsf-output-error">gsf_output_error</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-is-closed">gsf_output_is_closed</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-wrap">gsf_output_wrap</a> (GObject *wrapper,
<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *wrapee);
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-unwrap">gsf_output_unwrap</a> (GObject *wrapper,
<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *wrapee);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2553223"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GsfOutput
+----<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
+----<a href="gsf-Compression.html#GsfOutputBzip">GsfOutputBzip</a>
+----<a href="gsf-Text.html#GsfOutputCsv">GsfOutputCsv</a>
+----<a href="gsf-Compression.html#GsfOutputGZip">GsfOutputGZip</a>
+----<a href="gsf-Text.html#GsfOutputIconv">GsfOutputIconv</a>
+----<a href="gsf-GIOChannel.html#GsfOutputIOChannel">GsfOutputIOChannel</a>
+----<a href="gsf-memory.html#GsfOutputMemory">GsfOutputMemory</a>
+----<a href="gsf-Reading-and-Writing-from-local-files-and-directories.html#GsfOutputStdio">GsfOutputStdio</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2553313"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="gsf-Output-to-unstructured-files.html#GsfOutput--is-closed">is-closed</a>" gboolean : Read
"<a href="gsf-Output-to-unstructured-files.html#GsfOutput--name">name</a>" gchararray : Read
"<a href="gsf-Output-to-unstructured-files.html#GsfOutput--position">position</a>" gint64 : Read
"<a href="gsf-Output-to-unstructured-files.html#GsfOutput--size">size</a>" gint64 : Read
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2553396"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2553410"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2553420"></a><h3>
<a name="GsfOutput-struct"></a>GsfOutput</h3>
<a class="indexterm" name="id2553433"></a><pre class="programlisting">typedef struct _GsfOutput GsfOutput;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553448"></a><h3>
<a name="gsf-output-container"></a>gsf_output_container ()</h3>
<a class="indexterm" name="id2553461"></a><pre class="programlisting"><a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* gsf_output_container (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>, but does not add a reference to <em class="parameter"><code>output</code></em>'s container.
Potentially NULL
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553527"></a><h3>
<a name="gsf-output-size"></a>gsf_output_size ()</h3>
<a class="indexterm" name="id2553540"></a><pre class="programlisting"><a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> gsf_output_size (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output);</pre>
<p>
Determine the size of the output stream <em class="parameter"><code>output</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the size of the output, or -1 if it does not have a size.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553615"></a><h3>
<a name="gsf-output-close"></a>gsf_output_close ()</h3>
<a class="indexterm" name="id2553627"></a><pre class="programlisting">gboolean gsf_output_close (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output);</pre>
<p>
Close a stream.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> FALSE on error
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553687"></a><h3>
<a name="gsf-output-tell"></a>gsf_output_tell ()</h3>
<a class="indexterm" name="id2553699"></a><pre class="programlisting"><a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> gsf_output_tell (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output);</pre>
<p>
Tell the current position in <em class="parameter"><code>output</code></em>, similar to
<span class="citerefentry"><span class="refentrytitle">ftell</span>(3)</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>: the current position in the file
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553782"></a><h3>
<a name="gsf-output-seek"></a>gsf_output_seek ()</h3>
<a class="indexterm" name="id2553794"></a><pre class="programlisting">gboolean gsf_output_seek (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
<a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> offset,
GSeekType whence);</pre>
<p>
Reposition in output stream <em class="parameter"><code>output</code></em>. <em class="parameter"><code>whence</code></em> specifies what the offset is
relative to: the beginning of the stream (<code class="literal">G_SEEK_SET</code>), current position in
the stream (<code class="literal">G_SEEK_CUR</code>) or the end of the stream (<code class="literal">G_SEEK_END</code>).
This function is similar to
<span class="citerefentry"><span class="refentrytitle">fseek</span>(3)</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> Relative amount to reposition
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>whence</code></em> :</span></td>
<td> What the offset is relative to.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> FALSE on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553961"></a><h3>
<a name="gsf-output-write"></a>gsf_output_write ()</h3>
<a class="indexterm" name="id2553974"></a><pre class="programlisting">gboolean gsf_output_write (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
size_t num_bytes,
guint8 const *data);</pre>
<p>
Write <em class="parameter"><code>num_bytes</code></em> of <em class="parameter"><code>data</code></em> to <em class="parameter"><code>output</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> Output stream
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>num_bytes</code></em> :</span></td>
<td> Number of bytes to write
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td> Data to write.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>: FALSE on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554095"></a><h3>
<a name="gsf-output-puts"></a>gsf_output_puts ()</h3>
<a class="indexterm" name="id2554108"></a><pre class="programlisting">gboolean gsf_output_puts (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *line);</pre>
<p>
Like fputs, this assumes that the line already ends with a newline</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> A <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>line</code></em> :</span></td>
<td> <code class="literal">null</code> terminated string to write
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if successful, FALSE if not
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554209"></a><h3>
<a name="gsf-output-printf"></a>gsf_output_printf ()</h3>
<a class="indexterm" name="id2554222"></a><pre class="programlisting">gboolean gsf_output_printf (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *format,
...);</pre>
<p>
Output <em class="parameter"><code>Varargs</code></em> to <em class="parameter"><code>output</code></em> using the format string <em class="parameter"><code>format</code></em>, similar to
<span class="citerefentry"><span class="refentrytitle">printf</span>(3)</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> A <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>format</code></em> :</span></td>
<td> The printf-style format string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
<td> the arguments for <em class="parameter"><code>format</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>: TRUE if successful, FALSE if not
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554358"></a><h3>
<a name="gsf-output-vprintf"></a>gsf_output_vprintf ()</h3>
<a class="indexterm" name="id2554371"></a><pre class="programlisting"><a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> gsf_output_vprintf (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *format,
va_list args);</pre>
<p>
Output <em class="parameter"><code>args</code></em> to <em class="parameter"><code>output</code></em> using the format string <em class="parameter"><code>format</code></em>, similar to
<span class="citerefentry"><span class="refentrytitle">vprintf</span>(3)</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> A <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>format</code></em> :</span></td>
<td> The printf-style format string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>args</code></em> :</span></td>
<td> the arguments for <em class="parameter"><code>format</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>: number of bytes printed, a negative value if not successful
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554514"></a><h3>
<a name="gsf-output-name"></a>gsf_output_name ()</h3>
<a class="indexterm" name="id2554527"></a><pre class="programlisting">charconst * gsf_output_name (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);</pre>
<p>
Give the name of <em class="parameter"><code>output</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>: <em class="parameter"><code>output</code></em>'s name in utf8 form, DO NOT FREE THIS STRING
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554607"></a><h3>
<a name="gsf-output-set-name-from-filename"></a>gsf_output_set_name_from_filename ()</h3>
<a class="indexterm" name="id2554621"></a><pre class="programlisting">gboolean gsf_output_set_name_from_filename
(<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
char const *filename);</pre>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>This is a utility routine that should only be used by derived
outputs.</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td> the output stream
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
<td> the (fs-sys encoded) filename
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the assignment was ok.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554707"></a><h3>
<a name="gsf-output-error-id"></a>gsf_output_error_id ()</h3>
<a class="indexterm" name="id2554720"></a><pre class="programlisting">GQuark gsf_output_error_id (void);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554756"></a><h3>
<a name="gsf-output-set-error"></a>gsf_output_set_error ()</h3>
<a class="indexterm" name="id2554768"></a><pre class="programlisting">gboolean gsf_output_set_error (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
gint code,
char const *format,
...);</pre>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>This is a utility routine that should only be used by derived
outputs.</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>code</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>format</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>...</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Always returns FALSE to facilitate its use.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554889"></a><h3>
<a name="gsf-output-error"></a>gsf_output_error ()</h3>
<a class="indexterm" name="id2554901"></a><pre class="programlisting">GErrorconst * gsf_output_error (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the last error logged on the output, or NULL.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554961"></a><h3>
<a name="gsf-output-is-closed"></a>gsf_output_is_closed ()</h3>
<a class="indexterm" name="id2554975"></a><pre class="programlisting">gboolean gsf_output_is_closed (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> const *output);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>output</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if <em class="parameter"><code>output</code></em> has already been closed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555041"></a><h3>
<a name="gsf-output-wrap"></a>gsf_output_wrap ()</h3>
<a class="indexterm" name="id2555053"></a><pre class="programlisting">gboolean gsf_output_wrap (GObject *wrapper,
<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *wrapee);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>wrapee</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the wrapping succeeded.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555134"></a><h3>
<a name="gsf-output-unwrap"></a>gsf_output_unwrap ()</h3>
<a class="indexterm" name="id2555147"></a><pre class="programlisting">gboolean gsf_output_unwrap (GObject *wrapper,
<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *wrapee);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>wrapee</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the unwrapping succeeded.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2555229"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2555239"></a><h3>
<a name="GsfOutput--is-closed"></a>The "<code class="literal">is-closed</code>" property</h3>
<a class="indexterm" name="id2555256"></a><pre class="programlisting"> "is-closed" gboolean : Read</pre>
<p>Whether the Output is Closed.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555282"></a><h3>
<a name="GsfOutput--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2555298"></a><pre class="programlisting"> "name" gchararray : Read</pre>
<p>The Output's Name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555325"></a><h3>
<a name="GsfOutput--position"></a>The "<code class="literal">position</code>" property</h3>
<a class="indexterm" name="id2555340"></a><pre class="programlisting"> "position" gint64 : Read</pre>
<p>The Output's Current Position.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555370"></a><h3>
<a name="GsfOutput--size"></a>The "<code class="literal">size</code>" property</h3>
<a class="indexterm" name="id2555386"></a><pre class="programlisting"> "size" gint64 : Read</pre>
<p>The Output's Size.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
</div>
</body>
</html>
|
