mirror of https://github.com/Gnucash/gnucash
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
826 lines
28 KiB
826 lines
28 KiB
<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.4 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="into.html" title="Part I. GSF Overview">
|
|
<link rel="part" href="api.html" title="Part II. 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" 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></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">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);
|
|
|
|
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-set-name">gsf_output_set_name</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
|
|
char const *name);
|
|
gboolean <a href="gsf-Output-to-unstructured-files.html#gsf-output-set-container">gsf_output_set_container</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
|
|
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a> *container);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2521215"></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-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="id2521275"></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="id2521353"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2521362"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2521368"></a><h3>
|
|
<a name="GsfOutput-struct"></a>GsfOutput</h3>
|
|
<a class="indexterm" name="id2521379"></a><pre class="programlisting">typedef struct _GsfOutput GsfOutput;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2521394"></a><h3>
|
|
<a name="gsf-output-container"></a>gsf_output_container ()</h3>
|
|
<a class="indexterm" name="id2521404"></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="id2521471"></a><h3>
|
|
<a name="gsf-output-size"></a>gsf_output_size ()</h3>
|
|
<a class="indexterm" name="id2521482"></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>
|
|
</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 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="id2521542"></a><h3>
|
|
<a name="gsf-output-close"></a>gsf_output_close ()</h3>
|
|
<a class="indexterm" name="id2521552"></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="id2521612"></a><h3>
|
|
<a name="gsf-output-tell"></a>gsf_output_tell ()</h3>
|
|
<a class="indexterm" name="id2521622"></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>
|
|
</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 current position in the file
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2521682"></a><h3>
|
|
<a name="gsf-output-seek"></a>gsf_output_seek ()</h3>
|
|
<a class="indexterm" name="id2521692"></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>
|
|
</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"><em class="parameter"><code>offset</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>whence</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="id2521794"></a><h3>
|
|
<a name="gsf-output-write"></a>gsf_output_write ()</h3>
|
|
<a class="indexterm" name="id2521804"></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>
|
|
</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"><em class="parameter"><code>num_bytes</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>data</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="id2521906"></a><h3>
|
|
<a name="gsf-output-puts"></a>gsf_output_puts ()</h3>
|
|
<a class="indexterm" name="id2521916"></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="id2522013"></a><h3>
|
|
<a name="gsf-output-printf"></a>gsf_output_printf ()</h3>
|
|
<a class="indexterm" name="id2522024"></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>
|
|
</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="id2522133"></a><h3>
|
|
<a name="gsf-output-vprintf"></a>gsf_output_vprintf ()</h3>
|
|
<a class="indexterm" name="id2522144"></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>
|
|
</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="id2522261"></a><h3>
|
|
<a name="gsf-output-name"></a>gsf_output_name ()</h3>
|
|
<a class="indexterm" name="id2522271"></a><pre class="programlisting">charconst * gsf_output_name (<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>
|
|
<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="id2522336"></a><h3>
|
|
<a name="gsf-output-set-name-from-filename"></a>gsf_output_set_name_from_filename ()</h3>
|
|
<a class="indexterm" name="id2522348"></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="id2522434"></a><h3>
|
|
<a name="gsf-output-error-id"></a>gsf_output_error_id ()</h3>
|
|
<a class="indexterm" name="id2522445"></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="id2522480"></a><h3>
|
|
<a name="gsf-output-set-error"></a>gsf_output_set_error ()</h3>
|
|
<a class="indexterm" name="id2522491"></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="id2522611"></a><h3>
|
|
<a name="gsf-output-error"></a>gsf_output_error ()</h3>
|
|
<a class="indexterm" name="id2522621"></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="id2522681"></a><h3>
|
|
<a name="gsf-output-is-closed"></a>gsf_output_is_closed ()</h3>
|
|
<a class="indexterm" name="id2522692"></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="id2522758"></a><h3>
|
|
<a name="gsf-output-wrap"></a>gsf_output_wrap ()</h3>
|
|
<a class="indexterm" name="id2522768"></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="id2522849"></a><h3>
|
|
<a name="gsf-output-unwrap"></a>gsf_output_unwrap ()</h3>
|
|
<a class="indexterm" name="id2522860"></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>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2522940"></a><h3>
|
|
<a name="gsf-output-set-name"></a>gsf_output_set_name ()</h3>
|
|
<a class="indexterm" name="id2522951"></a><pre class="programlisting">gboolean gsf_output_set_name (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
|
|
char const *name);</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>name</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 assignment was ok.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2523035"></a><h3>
|
|
<a name="gsf-output-set-container"></a>gsf_output_set_container ()</h3>
|
|
<a class="indexterm" name="id2523046"></a><pre class="programlisting">gboolean gsf_output_set_container (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *output,
|
|
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a> *container);</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>container</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 assignment was ok.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2523132"></a><h2>Properties</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2523137"></a><h3>
|
|
<a name="GsfOutput--is-closed"></a>The "<code class="literal">is-closed</code>" property</h3>
|
|
<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="id2523174"></a><h3>
|
|
<a name="GsfOutput--name"></a>The "<code class="literal">name</code>" property</h3>
|
|
<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="id2523211"></a><h3>
|
|
<a name="GsfOutput--position"></a>The "<code class="literal">position</code>" property</h3>
|
|
<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="id2523251"></a><h3>
|
|
<a name="GsfOutput--size"></a>The "<code class="literal">size</code>" property</h3>
|
|
<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>
|
|
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
|
|
<td align="left"><a accesskey="p" href="gsf-Input-from-unstructured-files.html"><b><< Input from unstructured files</b></a></td>
|
|
<td align="right"><a accesskey="n" href="sources.html"><b>Stream Sources >></b></a></td>
|
|
</tr></table>
|
|
</body>
|
|
</html>
|