doc/html/gsf-Output-to-unstructured-files.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Output to unstructured files</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GSF Reference Manual">
   8 <link rel="up" href="io.html" title="Basic Input/Output">
   9 <link rel="prev" href="gsf-Input-from-unstructured-files.html" title="Input from unstructured files">
  10 <link rel="next" href="sources.html" title="Stream Sources">
  11 <meta name="generator" content="GTK-Doc V1.14 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <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>
  18 <td><a accesskey="u" href="io.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GSF Reference Manual</th>
  21 <td><a accesskey="n" href="sources.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gsf-Output-to-unstructured-files.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gsf-Output-to-unstructured-files.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gsf-Output-to-unstructured-files.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gsf-Output-to-unstructured-files.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry" title="Output to unstructured files">
  34 <a name="gsf-Output-to-unstructured-files"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gsf-Output-to-unstructured-files.top_of_page"></a>Output to unstructured files</span></h2>
  38 <p>Output to unstructured files</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv" title="Synopsis">
  43 <a name="gsf-Output-to-unstructured-files.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GsfOutput"></a><pre class="synopsis">                    <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput-struct" title="GsfOutput">GsfOutput</a>;
  45 <a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>           <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-size" title="gsf_output_size ()">gsf_output_size</a>                     (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);
  46 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-close" title="gsf_output_close ()">gsf_output_close</a>                    (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);
  47 <a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>           <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-tell" title="gsf_output_tell ()">gsf_output_tell</a>                     (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);
  48 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-seek" title="gsf_output_seek ()">gsf_output_seek</a>                     (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
  49                                                          <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>,
  50                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GSeekType"><span class="type">GSeekType</span></a> whence</code></em>);
  51 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-write" title="gsf_output_write ()">gsf_output_write</a>                    (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
  52                                                          <em class="parameter"><code><span class="type">size_t</span> num_bytes</code></em>,
  53                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> const *data</code></em>);
  54 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-puts" title="gsf_output_puts ()">gsf_output_puts</a>                     (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
  55                                                          <em class="parameter"><code><span class="type">char</span> const *line</code></em>);
  56 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-printf" title="gsf_output_printf ()">gsf_output_printf</a>                   (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
  57                                                          <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
  58                                                          <em class="parameter"><code>...</code></em>);
  59 <a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>           <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-vprintf" title="gsf_output_vprintf ()">gsf_output_vprintf</a>                  (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
  60                                                          <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
  61                                                          <em class="parameter"><code><span class="type">va_list</span> args</code></em>);
  62 <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *        <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-container" title="gsf_output_container ()">gsf_output_container</a>                (<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>);
  63 <span class="returnvalue">char</span> const   *      <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-name" title="gsf_output_name ()">gsf_output_name</a>                     (<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>);
  64 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>   (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
  65                                                          <em class="parameter"><code><span class="type">char</span> const *filename</code></em>);
  66 <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-error-id" title="gsf_output_error_id ()">gsf_output_error_id</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
  67 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-set-error" title="gsf_output_set_error ()">gsf_output_set_error</a>                (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
  68                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
  69                                                          <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
  70                                                          <em class="parameter"><code>...</code></em>);
  71 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> const *      <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-error" title="gsf_output_error ()">gsf_output_error</a>                    (<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>);
  72 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-is-closed" title="gsf_output_is_closed ()">gsf_output_is_closed</a>                (<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>);
  73 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-wrap" title="gsf_output_wrap ()">gsf_output_wrap</a>                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *wrapper</code></em>,
  74                                                          <em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *wrapee</code></em>);
  75 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-Output-to-unstructured-files.html#gsf-output-unwrap" title="gsf_output_unwrap ()">gsf_output_unwrap</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *wrapper</code></em>,
  76                                                          <em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *wrapee</code></em>);
  77 </pre>
  78 </div>
  79 <div class="refsect1" title="Object Hierarchy">
  80 <a name="gsf-Output-to-unstructured-files.object-hierarchy"></a><h2>Object Hierarchy</h2>
  81 <pre class="synopsis">
  82   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  83    +----GsfOutput
  84          +----<a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
  85          +----<a class="link" href="gsf-Compression.html#GsfOutputBzip">GsfOutputBzip</a>
  86          +----<a class="link" href="gsf-Text.html#GsfOutputCsv">GsfOutputCsv</a>
  87          +----<a class="link" href="gsf-Compression.html#GsfOutputGZip">GsfOutputGZip</a>
  88          +----<a class="link" href="gsf-Text.html#GsfOutputIconv">GsfOutputIconv</a>
  89          +----<a class="link" href="gsf-GIOChannel.html#GsfOutputIOChannel">GsfOutputIOChannel</a>
  90          +----<a class="link" href="gsf-memory.html#GsfOutputMemory">GsfOutputMemory</a>
  91          +----<a class="link" href="gsf-Reading-and-Writing-from-local-files-and-directories.html#GsfOutputStdio">GsfOutputStdio</a>
  92 </pre>
  93 </div>
  94 <div class="refsect1" title="Properties">
  95 <a name="gsf-Output-to-unstructured-files.properties"></a><h2>Properties</h2>
  96 <pre class="synopsis">
  97   "<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--is-closed" title='The "is-closed" property'>is-closed</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
  98   "<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--name" title='The "name" property'>name</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  99   "<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--position" title='The "position" property'>position</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read
 100   "<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput--size" title='The "size" property'>size</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read
 101 </pre>
 102 </div>
 103 <div class="refsect1" title="Description">
 104 <a name="gsf-Output-to-unstructured-files.description"></a><h2>Description</h2>
 105 <p>
 106 </p>
 107 </div>
 108 <div class="refsect1" title="Details">
 109 <a name="gsf-Output-to-unstructured-files.details"></a><h2>Details</h2>
 110 <div class="refsect2" title="GsfOutput">
 111 <a name="GsfOutput-struct"></a><h3>GsfOutput</h3>
 112 <pre class="programlisting">typedef struct _GsfOutput GsfOutput;</pre>
 113 <p>
 114 Class representing an output stream, counterpart to <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>.
 115 </p>
 116 </div>
 117 <hr>
 118 <div class="refsect2" title="gsf_output_size ()">
 119 <a name="gsf-output-size"></a><h3>gsf_output_size ()</h3>
 120 <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>
 121 <p>
 122 Determine the size of the output stream <em class="parameter"><code>output</code></em>.
 123 </p>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody>
 127 <tr>
 128 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 129 <td>
 130 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 131 </td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 135 <td> the size of the output, or -1 if it does not have a size.
 136 </td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <hr>
 142 <div class="refsect2" title="gsf_output_close ()">
 143 <a name="gsf-output-close"></a><h3>gsf_output_close ()</h3>
 144 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>
 145 <p>
 146 Close a stream.
 147 </p>
 148 <div class="variablelist"><table border="0">
 149 <col align="left" valign="top">
 150 <tbody>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 153 <td>
 154 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 155 </td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 159 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error
 160 </td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 <hr>
 166 <div class="refsect2" title="gsf_output_tell ()">
 167 <a name="gsf-output-tell"></a><h3>gsf_output_tell ()</h3>
 168 <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>
 169 <p>
 170 Tell the current position in <em class="parameter"><code>output</code></em>, similar to
 171 <span class="citerefentry"><span class="refentrytitle">ftell</span>(3)</span>.
 172 </p>
 173 <div class="variablelist"><table border="0">
 174 <col align="left" valign="top">
 175 <tbody>
 176 <tr>
 177 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 178 <td>
 179 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 180 </td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 184 <td> the current position in the file
 185 </td>
 186 </tr>
 187 </tbody>
 188 </table></div>
 189 </div>
 190 <hr>
 191 <div class="refsect2" title="gsf_output_seek ()">
 192 <a name="gsf-output-seek"></a><h3>gsf_output_seek ()</h3>
 193 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 194                                                          <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>,
 195                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GSeekType"><span class="type">GSeekType</span></a> whence</code></em>);</pre>
 196 <p>
 197 Reposition in output stream <em class="parameter"><code>output</code></em>. <em class="parameter"><code>whence</code></em> specifies what the offset is
 198 relative to: the beginning of the stream (<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-SEEK-SET:CAPS"><code class="literal">G_SEEK_SET</code></a>), current position in
 199 the stream (<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-SEEK-CUR:CAPS"><code class="literal">G_SEEK_CUR</code></a>) or the end of the stream (<a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#G-SEEK-END:CAPS"><code class="literal">G_SEEK_END</code></a>).
 200 This function is similar to
 201 <span class="citerefentry"><span class="refentrytitle">fseek</span>(3)</span>.
 202 </p>
 203 <div class="variablelist"><table border="0">
 204 <col align="left" valign="top">
 205 <tbody>
 206 <tr>
 207 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 208 <td>
 209 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 210 </td>
 211 </tr>
 212 <tr>
 213 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 214 <td>Relative amount to reposition
 215 </td>
 216 </tr>
 217 <tr>
 218 <td><p><span class="term"><em class="parameter"><code>whence</code></em> :</span></p></td>
 219 <td>What the offset is relative to.
 220 </td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 224 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.
 225 </td>
 226 </tr>
 227 </tbody>
 228 </table></div>
 229 </div>
 230 <hr>
 231 <div class="refsect2" title="gsf_output_write ()">
 232 <a name="gsf-output-write"></a><h3>gsf_output_write ()</h3>
 233 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 234                                                          <em class="parameter"><code><span class="type">size_t</span> num_bytes</code></em>,
 235                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> const *data</code></em>);</pre>
 236 <p>
 237 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>.
 238 </p>
 239 <div class="variablelist"><table border="0">
 240 <col align="left" valign="top">
 241 <tbody>
 242 <tr>
 243 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 244 <td>Output stream
 245 </td>
 246 </tr>
 247 <tr>
 248 <td><p><span class="term"><em class="parameter"><code>num_bytes</code></em> :</span></p></td>
 249 <td>Number of bytes to write
 250 </td>
 251 </tr>
 252 <tr>
 253 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 254 <td>Data to write.
 255 </td>
 256 </tr>
 257 <tr>
 258 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 259 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.
 260 </td>
 261 </tr>
 262 </tbody>
 263 </table></div>
 264 </div>
 265 <hr>
 266 <div class="refsect2" title="gsf_output_puts ()">
 267 <a name="gsf-output-puts"></a><h3>gsf_output_puts ()</h3>
 268 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 269                                                          <em class="parameter"><code><span class="type">char</span> const *line</code></em>);</pre>
 270 <p>
 271 Like fputs, this assumes that the line already ends with a newline
 272 </p>
 273 <div class="variablelist"><table border="0">
 274 <col align="left" valign="top">
 275 <tbody>
 276 <tr>
 277 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 278 <td>A <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 279 </td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
 283 <td>
 284 <code class="literal">null</code> terminated string to write
 285 </td>
 286 </tr>
 287 <tr>
 288 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 289 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not
 290 </td>
 291 </tr>
 292 </tbody>
 293 </table></div>
 294 </div>
 295 <hr>
 296 <div class="refsect2" title="gsf_output_printf ()">
 297 <a name="gsf-output-printf"></a><h3>gsf_output_printf ()</h3>
 298 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 299                                                          <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
 300                                                          <em class="parameter"><code>...</code></em>);</pre>
 301 <p>
 302 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
 303 <span class="citerefentry"><span class="refentrytitle">printf</span>(3)</span>.
 304 </p>
 305 <div class="variablelist"><table border="0">
 306 <col align="left" valign="top">
 307 <tbody>
 308 <tr>
 309 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 310 <td>A <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 311 </td>
 312 </tr>
 313 <tr>
 314 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
 315 <td>The printf-style format string
 316 </td>
 317 </tr>
 318 <tr>
 319 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 320 <td>the arguments for <em class="parameter"><code>format</code></em>
 321 </td>
 322 </tr>
 323 <tr>
 324 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 325 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not
 326 </td>
 327 </tr>
 328 </tbody>
 329 </table></div>
 330 </div>
 331 <hr>
 332 <div class="refsect2" title="gsf_output_vprintf ()">
 333 <a name="gsf-output-vprintf"></a><h3>gsf_output_vprintf ()</h3>
 334 <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>,
 335                                                          <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
 336                                                          <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
 337 <p>
 338 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
 339 <span class="citerefentry"><span class="refentrytitle">vprintf</span>(3)</span>.
 340 </p>
 341 <div class="variablelist"><table border="0">
 342 <col align="left" valign="top">
 343 <tbody>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 346 <td>A <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 347 </td>
 348 </tr>
 349 <tr>
 350 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
 351 <td>The printf-style format string
 352 </td>
 353 </tr>
 354 <tr>
 355 <td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
 356 <td>the arguments for <em class="parameter"><code>format</code></em>
 357 </td>
 358 </tr>
 359 <tr>
 360 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 361 <td> number of bytes printed, a negative value if not successful
 362 </td>
 363 </tr>
 364 </tbody>
 365 </table></div>
 366 </div>
 367 <hr>
 368 <div class="refsect2" title="gsf_output_container ()">
 369 <a name="gsf-output-container"></a><h3>gsf_output_container ()</h3>
 370 <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>
 371 <div class="variablelist"><table border="0">
 372 <col align="left" valign="top">
 373 <tbody><tr>
 374 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 375 <td> but does not add a reference to <em class="parameter"><code>output</code></em>'s container.
 376         Potentially <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 377 </td>
 378 </tr></tbody>
 379 </table></div>
 380 </div>
 381 <hr>
 382 <div class="refsect2" title="gsf_output_name ()">
 383 <a name="gsf-output-name"></a><h3>gsf_output_name ()</h3>
 384 <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>
 385 <p>
 386 Give the name of <em class="parameter"><code>output</code></em>.
 387 </p>
 388 <div class="variablelist"><table border="0">
 389 <col align="left" valign="top">
 390 <tbody>
 391 <tr>
 392 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 393 <td>
 394 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 395 </td>
 396 </tr>
 397 <tr>
 398 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 399 <td> <em class="parameter"><code>output</code></em>'s name in utf8 form, DO NOT FREE THIS STRING
 400 </td>
 401 </tr>
 402 </tbody>
 403 </table></div>
 404 </div>
 405 <hr>
 406 <div class="refsect2" title="gsf_output_set_name_from_filename ()">
 407 <a name="gsf-output-set-name-from-filename"></a><h3>gsf_output_set_name_from_filename ()</h3>
 408 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 409                                                          <em class="parameter"><code><span class="type">char</span> const *filename</code></em>);</pre>
 410 <p>
 411 </p>
 412 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 413 <h3 class="title">Note</h3>This is a utility routine that should only be used by derived
 414 outputs.</div>
 415 <p>
 416 </p>
 417 <div class="variablelist"><table border="0">
 418 <col align="left" valign="top">
 419 <tbody>
 420 <tr>
 421 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 422 <td>the output stream
 423 </td>
 424 </tr>
 425 <tr>
 426 <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 427 <td>the (fs-sys encoded) filename
 428 </td>
 429 </tr>
 430 <tr>
 431 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 432 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the assignment was ok.
 433 </td>
 434 </tr>
 435 </tbody>
 436 </table></div>
 437 </div>
 438 <hr>
 439 <div class="refsect2" title="gsf_output_error_id ()">
 440 <a name="gsf-output-error-id"></a><h3>gsf_output_error_id ()</h3>
 441 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              gsf_output_error_id                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 442 <p>
 443 </p>
 444 <div class="variablelist"><table border="0">
 445 <col align="left" valign="top">
 446 <tbody><tr>
 447 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 448 <td>
 449 </td>
 450 </tr></tbody>
 451 </table></div>
 452 </div>
 453 <hr>
 454 <div class="refsect2" title="gsf_output_set_error ()">
 455 <a name="gsf-output-set-error"></a><h3>gsf_output_set_error ()</h3>
 456 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 457                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
 458                                                          <em class="parameter"><code><span class="type">char</span> const *format</code></em>,
 459                                                          <em class="parameter"><code>...</code></em>);</pre>
 460 <p>
 461 </p>
 462 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 463 <h3 class="title">Note</h3>This is a utility routine that should only be used by derived
 464 outputs.</div>
 465 <p>
 466 </p>
 467 <div class="variablelist"><table border="0">
 468 <col align="left" valign="top">
 469 <tbody>
 470 <tr>
 471 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 472 <td>
 473 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 474 </td>
 475 </tr>
 476 <tr>
 477 <td><p><span class="term"><em class="parameter"><code>code</code></em> :</span></p></td>
 478 <td>The error id
 479 </td>
 480 </tr>
 481 <tr>
 482 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
 483 <td>printf style format string
 484 </td>
 485 </tr>
 486 <tr>
 487 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 488 <td>arguments for <em class="parameter"><code>format</code></em>
 489 </td>
 490 </tr>
 491 <tr>
 492 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 493 <td> Always returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to facilitate its use.
 494 </td>
 495 </tr>
 496 </tbody>
 497 </table></div>
 498 </div>
 499 <hr>
 500 <div class="refsect2" title="gsf_output_error ()">
 501 <a name="gsf-output-error"></a><h3>gsf_output_error ()</h3>
 502 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> 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>
 503 <div class="variablelist"><table border="0">
 504 <col align="left" valign="top">
 505 <tbody><tr>
 506 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 507 <td> the last error logged on the output, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 508 </td>
 509 </tr></tbody>
 510 </table></div>
 511 </div>
 512 <hr>
 513 <div class="refsect2" title="gsf_output_is_closed ()">
 514 <a name="gsf-output-is-closed"></a><h3>gsf_output_is_closed ()</h3>
 515 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>
 516 <div class="variablelist"><table border="0">
 517 <col align="left" valign="top">
 518 <tbody>
 519 <tr>
 520 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 521 <td>
 522 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 523 </td>
 524 </tr>
 525 <tr>
 526 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 527 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>output</code></em> has already been closed.
 528 </td>
 529 </tr>
 530 </tbody>
 531 </table></div>
 532 </div>
 533 <hr>
 534 <div class="refsect2" title="gsf_output_wrap ()">
 535 <a name="gsf-output-wrap"></a><h3>gsf_output_wrap ()</h3>
 536 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsf_output_wrap                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *wrapper</code></em>,
 537                                                          <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>
 538 <div class="variablelist"><table border="0">
 539 <col align="left" valign="top">
 540 <tbody><tr>
 541 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 542 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the wrapping succeeded.
 543 </td>
 544 </tr></tbody>
 545 </table></div>
 546 </div>
 547 <hr>
 548 <div class="refsect2" title="gsf_output_unwrap ()">
 549 <a name="gsf-output-unwrap"></a><h3>gsf_output_unwrap ()</h3>
 550 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsf_output_unwrap                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *wrapper</code></em>,
 551                                                          <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>
 552 <div class="variablelist"><table border="0">
 553 <col align="left" valign="top">
 554 <tbody><tr>
 555 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 556 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the unwrapping succeeded.
 557 </td>
 558 </tr></tbody>
 559 </table></div>
 560 </div>
 561 </div>
 562 <div class="refsect1" title="Property Details">
 563 <a name="gsf-Output-to-unstructured-files.property-details"></a><h2>Property Details</h2>
 564 <div class="refsect2" title='The "is-closed" property'>
 565 <a name="GsfOutput--is-closed"></a><h3>The <code class="literal">"is-closed"</code> property</h3>
 566 <pre class="programlisting">  "is-closed"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
 567 <p>Whether the Output is Closed.</p>
 568 <p>Default value: FALSE</p>
 569 </div>
 570 <hr>
 571 <div class="refsect2" title='The "name" property'>
 572 <a name="GsfOutput--name"></a><h3>The <code class="literal">"name"</code> property</h3>
 573 <pre class="programlisting">  "name"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
 574 <p>The Output's Name.</p>
 575 <p>Default value: NULL</p>
 576 </div>
 577 <hr>
 578 <div class="refsect2" title='The "position" property'>
 579 <a name="GsfOutput--position"></a><h3>The <code class="literal">"position"</code> property</h3>
 580 <pre class="programlisting">  "position"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read</pre>
 581 <p>The Output's Current Position.</p>
 582 <p>Allowed values: &gt;= 0</p>
 583 <p>Default value: 0</p>
 584 </div>
 585 <hr>
 586 <div class="refsect2" title='The "size" property'>
 587 <a name="GsfOutput--size"></a><h3>The <code class="literal">"size"</code> property</h3>
 588 <pre class="programlisting">  "size"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a>                : Read</pre>
 589 <p>The Output's Size.</p>
 590 <p>Allowed values: &gt;= 0</p>
 591 <p>Default value: 0</p>
 592 </div>
 593 </div>
 594 </div>
 595 <div class="footer">
 596 <hr>
 597           Generated by GTK-Doc V1.14</div>
 598 </body>
 599 </html>