RubyGems - gsf - Versions diffs - 3.0.9-x64-mingw32 - Mend

gsf 3.0.9-x64-mingw32

Files changed (166) hide show

data/vendor/local/share/gtk-doc/html/gsf/gsf-Output-to-unstructured-files.html ADDED Viewed

@@ -0,0 +1,830 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GSF Reference Manual: Output to unstructured files</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" 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.20 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</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="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
+                  <a href="#gsf-Output-to-unstructured-files.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
+                  <a href="#gsf-Output-to-unstructured-files.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
+                  <a href="#gsf-Output-to-unstructured-files.properties" class="shortcut">Properties</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="io.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="gsf-Input-from-unstructured-files.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="sources.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<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="gsf-Output-to-unstructured-files.top_of_page"></a>Output to unstructured files</span></h2>
+<p>Output to unstructured files</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-size" title="gsf_output_size ()">gsf_output_size</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-close" title="gsf_output_close ()">gsf_output_close</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-tell" title="gsf_output_tell ()">gsf_output_tell</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-seek" title="gsf_output_seek ()">gsf_output_seek</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-write" title="gsf_output_write ()">gsf_output_write</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-puts" title="gsf_output_puts ()">gsf_output_puts</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-printf" title="gsf_output_printf ()">gsf_output_printf</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-vprintf" title="gsf_output_vprintf ()">gsf_output_vprintf</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-container" title="gsf_output_container ()">gsf_output_container</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">char</span> const   *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-name" title="gsf_output_name ()">gsf_output_name</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-set-name-from-filename" title="gsf_output_set_name_from_filename ()">gsf_output_set_name_from_filename</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GQuark</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-error-id" title="gsf_output_error_id ()">gsf_output_error_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-set-error" title="gsf_output_set_error ()">gsf_output_set_error</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GError</span> const *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-error" title="gsf_output_error ()">gsf_output_error</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-is-closed" title="gsf_output_is_closed ()">gsf_output_is_closed</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-wrap" title="gsf_output_wrap ()">gsf_output_wrap</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-unwrap" title="gsf_output_unwrap ()">gsf_output_unwrap</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.properties"></a><h2>Properties</h2>
+<div class="informaltable"><table border="0">
+<colgroup>
+<col width="150px" class="properties_type">
+<col width="300px" class="properties_name">
+<col width="200px" class="properties_flags">
+</colgroup>
+<tbody>
+<tr>
+<td class="property_type">
+<a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="type">GsfOutfile</span></a> *</td>
+<td class="property_name"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--container" title="The “container” property">container</a></td>
+<td class="property_flags">Read / Write</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gboolean</span></td>
+<td class="property_name"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--is-closed" title="The “is-closed” property">is-closed</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type">
+<span class="type">GDateTime</span> *</td>
+<td class="property_name"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--modtime" title="The “modtime” property">modtime</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type">
+<span class="type">gchar</span> *</td>
+<td class="property_name"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--name" title="The “name” property">name</a></td>
+<td class="property_flags">Read / Write</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gint64</span></td>
+<td class="property_name"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--position" title="The “position” property">position</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gint64</span></td>
+<td class="property_name"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--size" title="The “size” property">size</a></td>
+<td class="property_flags">Read</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<a name="GsfOutput"></a><div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody><tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput-struct" title="GsfOutput">GsfOutput</a></td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">╰──</span> GsfOutput
+        <span class="lineart">├──</span> <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-Compression.html#GsfOutputBzip">GsfOutputBzip</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-Text.html#GsfOutputCsv">GsfOutputCsv</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-Compression.html#GsfOutputGZip">GsfOutputGZip</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-Text.html#GsfOutputIconv">GsfOutputIconv</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-GIOChannel.html#GsfOutputIOChannel">GsfOutputIOChannel</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-memory.html#GsfOutputMemory">GsfOutputMemory</a>
+        <span class="lineart">╰──</span> <a class="link" href="gsf-Reading-and-Writing-from-local-files-and-directories.html#GsfOutputStdio">GsfOutputStdio</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.description"></a><h2>Description</h2>
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gsf-output-size"></a><h3>gsf_output_size ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+gsf_output_size (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);</pre>
+<p>Determine the size of the output stream <em class="parameter"><code>output</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.2.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.2.6"></a><h4>Returns</h4>
+<p> the size of the output, or -1 if it does not have a size.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-close"></a><h3>gsf_output_close ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_close (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);</pre>
+<p>Close a stream.</p>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.3.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.3.6"></a><h4>Returns</h4>
+<p> <code class="literal">FALSE</code> on error</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-tell"></a><h3>gsf_output_tell ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+gsf_output_tell (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);</pre>
+<p>Tell the current position in <em class="parameter"><code>output</code></em>
+, similar to</p>
+<span class="citerefentry"><span class="refentrytitle">ftell</span>(3)</span>.
+<div class="refsect3">
+<a name="id-1.6.3.3.9.4.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.4.7"></a><h4>Returns</h4>
+<p> the current position in the file</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-seek"></a><h3>gsf_output_seek ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_seek (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
+                 <em class="parameter"><code><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> offset</code></em>,
+                 <em class="parameter"><code><span class="type">GSeekType</span> whence</code></em>);</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</p>
+<span class="citerefentry"><span class="refentrytitle">fseek</span>(3)</span>.
+<div class="refsect3">
+<a name="id-1.6.3.3.9.5.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>offset</p></td>
+<td class="parameter_description"><p>Relative amount to reposition</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>whence</p></td>
+<td class="parameter_description"><p>What the offset is relative to.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.5.7"></a><h4>Returns</h4>
+<p> <code class="literal">FALSE</code> on error.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-write"></a><h3>gsf_output_write ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_write (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
+                  <em class="parameter"><code><span class="type">size_t</span> num_bytes</code></em>,
+                  <em class="parameter"><code><span class="type">guint8</span> const *data</code></em>);</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>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.6.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p>Output stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>num_bytes</p></td>
+<td class="parameter_description"><p>Number of bytes to write</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p> Data to write. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=num_bytes]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.6.6"></a><h4>Returns</h4>
+<p> <code class="literal">FALSE</code> on error.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-puts"></a><h3>gsf_output_puts ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_puts (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
+                 <em class="parameter"><code><span class="type">char</span> const *line</code></em>);</pre>
+<p>Like fputs, this assumes that the line already ends with a newline</p>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.7.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p>A <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>line</p></td>
+<td class="parameter_description"><p>Nul terminated string to write</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.7.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> if not</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-printf"></a><h3>gsf_output_printf ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_printf (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
+                   <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
+                   <em class="parameter"><code>...</code></em>);</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</p>
+<span class="citerefentry"><span class="refentrytitle">printf</span>(3)</span>.
+<div class="refsect3">
+<a name="id-1.6.3.3.9.8.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p>A <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>format</p></td>
+<td class="parameter_description"><p>The printf-style format string</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>...</p></td>
+<td class="parameter_description"><p>the arguments for <em class="parameter"><code>format</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.8.7"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> if not</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-vprintf"></a><h3>gsf_output_vprintf ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+gsf_output_vprintf (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
+                    <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
+                    <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</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</p>
+<span class="citerefentry"><span class="refentrytitle">vprintf</span>(3)</span>.
+<div class="refsect3">
+<a name="id-1.6.3.3.9.9.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p>A <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>format</p></td>
+<td class="parameter_description"><p>The printf-style format string</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>args</p></td>
+<td class="parameter_description"><p>the arguments for <em class="parameter"><code>format</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.9.7"></a><h4>Returns</h4>
+<p> number of bytes printed, a negative value if not successful</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-container"></a><h3>gsf_output_container ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
+gsf_output_container (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> const *output</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.10.4"></a><h4>Returns</h4>
+<p> <em class="parameter"><code>output</code></em>
+'s container, potentially <code class="literal">NULL</code>. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-name"></a><h3>gsf_output_name ()</h3>
+<pre class="programlisting"><span class="returnvalue">char</span> const   *
+gsf_output_name (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> const *output</code></em>);</pre>
+<p>Give the name of <em class="parameter"><code>output</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.11.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.11.6"></a><h4>Returns</h4>
+<p> <em class="parameter"><code>output</code></em>
+'s name in utf8 form. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-set-name-from-filename"></a><h3>gsf_output_set_name_from_filename ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_set_name_from_filename (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
+                                   <em class="parameter"><code><span class="type">char</span> const *filename</code></em>);</pre>
+<div class="note">This is a utility routine that should only be used by derived
+outputs.</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.12.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p>the output stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>filename</p></td>
+<td class="parameter_description"><p>the (fs-sys encoded) filename</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.12.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the assignment was ok.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-error-id"></a><h3>gsf_output_error_id ()</h3>
+<pre class="programlisting"><span class="returnvalue">GQuark</span>
+gsf_output_error_id (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+</p>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.13.5"></a><h4>Returns</h4>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-set-error"></a><h3>gsf_output_set_error ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_set_error (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
+                      <em class="parameter"><code><span class="type">gint</span> code</code></em>,
+                      <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
+                      <em class="parameter"><code>...</code></em>);</pre>
+<div class="note">This is a utility routine that should only be used by derived
+outputs.</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.14.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>code</p></td>
+<td class="parameter_description"><p>The error id</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>format</p></td>
+<td class="parameter_description"><p>printf style format string</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>...</p></td>
+<td class="parameter_description"><p>arguments for <em class="parameter"><code>format</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.14.6"></a><h4>Returns</h4>
+<p> Always returns <code class="literal">FALSE</code> to facilitate its use.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-error"></a><h3>gsf_output_error ()</h3>
+<pre class="programlisting"><span class="returnvalue">GError</span> const *
+gsf_output_error (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> const *output</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.15.4"></a><h4>Returns</h4>
+<p> the last error logged on the output, or <code class="literal">NULL</code>. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-is-closed"></a><h3>gsf_output_is_closed ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_is_closed (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> const *output</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.16.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.16.5"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if <em class="parameter"><code>output</code></em>
+has already been closed.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-wrap"></a><h3>gsf_output_wrap ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_wrap (<em class="parameter"><code><span class="type">GObject</span> *wrapper</code></em>,
+                 <em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *wrapee</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.17.4"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the wrapping succeeded.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-output-unwrap"></a><h3>gsf_output_unwrap ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_output_unwrap (<em class="parameter"><code><span class="type">GObject</span> *wrapper</code></em>,
+                   <em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *wrapee</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.3.9.18.4"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the unwrapping succeeded.</p>
+<p></p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GsfOutput-struct"></a><h3>GsfOutput</h3>
+<pre class="programlisting">typedef struct _GsfOutput GsfOutput;</pre>
+<p>Class representing an output stream, counterpart to <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>.</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-Output-to-unstructured-files.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="GsfOutput--container"></a><h3>The <code class="literal">“container”</code> property</h3>
+<pre class="programlisting">  “container”                <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="type">GsfOutfile</span></a> *</pre>
+<p>The container, optionally <code class="literal">NULL</code>, in which this output lives.</p>
+<p>Flags: Read / Write</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutput--is-closed"></a><h3>The <code class="literal">“is-closed”</code> property</h3>
+<pre class="programlisting">  “is-closed”                <span class="type">gboolean</span></pre>
+<p><code class="literal">TRUE</code> if the output has been closed.</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutput--modtime"></a><h3>The <code class="literal">“modtime”</code> property</h3>
+<pre class="programlisting">  “modtime”                  <span class="type">GDateTime</span> *</pre>
+<p>The time the output was last updated.  This must be set on object
+construction and represents the timestamp to put on the resulting
+file or <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="type">GsfOutfile</span></a> member.  Not all derived classes will actually
+do anything with this property.</p>
+<p>Flags: Read / Write / Construct Only</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutput--name"></a><h3>The <code class="literal">“name”</code> property</h3>
+<pre class="programlisting">  “name”                     <span class="type">gchar</span> *</pre>
+<p>The output's name.</p>
+<p>Flags: Read / Write</p>
+<p>Default value: NULL</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutput--position"></a><h3>The <code class="literal">“position”</code> property</h3>
+<pre class="programlisting">  “position”                 <span class="type">gint64</span></pre>
+<p>The current position in the output.</p>
+<p>Flags: Read</p>
+<p>Allowed values: &gt;= 0</p>
+<p>Default value: 0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutput--size"></a><h3>The <code class="literal">“size”</code> property</h3>
+<pre class="programlisting">  “size”                     <span class="type">gint64</span></pre>
+<p>The current file size.</p>
+<p>Flags: Read</p>
+<p>Allowed values: &gt;= 0</p>
+<p>Default value: 0</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>