File: //usr/local/ssl/share/gtk-doc/html/gsf/gsf-Output-to-unstructured-files.html
<!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.68.1">
<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.6 (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="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a>
 | 
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#properties" 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><span class="refentrytitle"><a name="top_of_page"></a>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">
<a name="synopsis"></a><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="object_hierarchy"></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="properties"></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="desc"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2525445"></a><h3>
<a name="GsfOutput-struct"></a>GsfOutput</h3>
<a class="indexterm" name="id2525456"></a><pre class="programlisting">typedef struct _GsfOutput GsfOutput;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2525471"></a><h3>
<a name="gsf-output-container"></a>gsf_output_container ()</h3>
<a class="indexterm" name="id2525484"></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="id2525550"></a><h3>
<a name="gsf-output-size"></a>gsf_output_size ()</h3>
<a class="indexterm" name="id2525563"></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="id2525637"></a><h3>
<a name="gsf-output-close"></a>gsf_output_close ()</h3>
<a class="indexterm" name="id2525650"></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="id2525710"></a><h3>
<a name="gsf-output-tell"></a>gsf_output_tell ()</h3>
<a class="indexterm" name="id2525723"></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="id2525805"></a><h3>
<a name="gsf-output-seek"></a>gsf_output_seek ()</h3>
<a class="indexterm" name="id2525817"></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="id2525985"></a><h3>
<a name="gsf-output-write"></a>gsf_output_write ()</h3>
<a class="indexterm" name="id2525997"></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="id2526119"></a><h3>
<a name="gsf-output-puts"></a>gsf_output_puts ()</h3>
<a class="indexterm" name="id2526131"></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="id2526232"></a><h3>
<a name="gsf-output-printf"></a>gsf_output_printf ()</h3>
<a class="indexterm" name="id2526245"></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="id2526381"></a><h3>
<a name="gsf-output-vprintf"></a>gsf_output_vprintf ()</h3>
<a class="indexterm" name="id2526394"></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="id2526537"></a><h3>
<a name="gsf-output-name"></a>gsf_output_name ()</h3>
<a class="indexterm" name="id2526550"></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="id2526631"></a><h3>
<a name="gsf-output-set-name-from-filename"></a>gsf_output_set_name_from_filename ()</h3>
<a class="indexterm" name="id2526645"></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="id2526731"></a><h3>
<a name="gsf-output-error-id"></a>gsf_output_error_id ()</h3>
<a class="indexterm" name="id2526744"></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="id2526779"></a><h3>
<a name="gsf-output-set-error"></a>gsf_output_set_error ()</h3>
<a class="indexterm" name="id2526792"></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="id2526912"></a><h3>
<a name="gsf-output-error"></a>gsf_output_error ()</h3>
<a class="indexterm" name="id2526924"></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="id2526985"></a><h3>
<a name="gsf-output-is-closed"></a>gsf_output_is_closed ()</h3>
<a class="indexterm" name="id2526998"></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="id2527064"></a><h3>
<a name="gsf-output-wrap"></a>gsf_output_wrap ()</h3>
<a class="indexterm" name="id2527076"></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="id2527157"></a><h3>
<a name="gsf-output-unwrap"></a>gsf_output_unwrap ()</h3>
<a class="indexterm" name="id2527170"></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="property_details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2527265"></a><h3>
<a name="GsfOutput--is-closed"></a>The "<code class="literal">is-closed</code>" property</h3>
<a class="indexterm" name="id2527280"></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="id2527306"></a><h3>
<a name="GsfOutput--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2527321"></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="id2527348"></a><h3>
<a name="GsfOutput--position"></a>The "<code class="literal">position</code>" property</h3>
<a class="indexterm" name="id2527364"></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="id2527394"></a><h3>
<a name="GsfOutput--size"></a>The "<code class="literal">size</code>" property</h3>
<a class="indexterm" name="id2527409"></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>