1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
|
<refentry id="gsf-Input-from-unstructured-files">
<refmeta>
<refentrytitle role="top_of_page">Input from unstructured files</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GSF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Input from unstructured files</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GsfInput"/><anchor id="GsfInputProxy"/>
<synopsis>
<link linkend="GsfInput-struct">GsfInput</link>;
<link linkend="guint8">guint8</link>const * <link linkend="gsf-input-read">gsf_input_read</link> (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="size-t">size_t</link> num_bytes,
<link linkend="guint8">guint8</link> *optional_buffer);
<link linkend="gsf-off-t">gsf_off_t</link> <link linkend="gsf-input-tell">gsf_input_tell</link> (<link linkend="GsfInput">GsfInput</link> *input);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-input-seek">gsf_input_seek</link> (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="gsf-off-t">gsf_off_t</link> offset,
<link linkend="GSeekType">GSeekType</link> whence);
<link linkend="GsfInfile">GsfInfile</link>* <link linkend="gsf-input-container">gsf_input_container</link> (<link linkend="GsfInput">GsfInput</link> *input);
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-dup">gsf_input_dup</link> (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="GError">GError</link> **err);
<link linkend="gsf-off-t">gsf_off_t</link> <link linkend="gsf-input-size">gsf_input_size</link> (<link linkend="GsfInput">GsfInput</link> *input);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-input-eof">gsf_input_eof</link> (<link linkend="GsfInput">GsfInput</link> *input);
<link linkend="gsf-off-t">gsf_off_t</link> <link linkend="gsf-input-remaining">gsf_input_remaining</link> (<link linkend="GsfInput">GsfInput</link> *input);
<link linkend="GQuark">GQuark</link> <link linkend="gsf-input-error-id">gsf_input_error_id</link> (void);
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-sibling">gsf_input_sibling</link> (<link linkend="GsfInput">GsfInput</link> const *input,
<link linkend="char">char</link> const *name,
<link linkend="GError">GError</link> **err);
<link linkend="GQuark">GQuark</link> <link linkend="gsf-input-error">gsf_input_error</link> (void);
<link linkend="char">char</link>const * <link linkend="gsf-input-name">gsf_input_name</link> (<link linkend="GsfInput">GsfInput</link> *input);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-input-set-name-from-filename">gsf_input_set_name_from_filename</link> (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="char">char</link> const *filename);
<link linkend="GsfInputProxy-struct">GsfInputProxy</link>;
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-proxy-new">gsf_input_proxy_new</link> (<link linkend="GsfInput">GsfInput</link> *source);
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-proxy-new-section">gsf_input_proxy_new_section</link> (<link linkend="GsfInput">GsfInput</link> *source,
<link linkend="gsf-off-t">gsf_off_t</link> offset,
<link linkend="gsf-off-t">gsf_off_t</link> size);
<link linkend="gboolean">gboolean</link> <link linkend="gsf-input-copy">gsf_input_copy</link> (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="GsfOutput">GsfOutput</link> *output);
<link linkend="GsfInput">GsfInput</link>* <link linkend="gsf-input-uncompress">gsf_input_uncompress</link> (<link linkend="GsfInput">GsfInput</link> *src);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GsfInput
+----<link linkend="GsfInfile">GsfInfile</link>
+----<link linkend="GsfInputGZip">GsfInputGZip</link>
+----<link linkend="GsfInputMemory">GsfInputMemory</link>
+----<link linkend="GsfInputProxy">GsfInputProxy</link>
+----<link linkend="GsfInputStdio">GsfInputStdio</link>
+----<link linkend="GsfInputTextline">GsfInputTextline</link>
</synopsis>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GsfInput">GsfInput</link>
+----GsfInputProxy
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GsfInput--eof">eof</link>" <link linkend="gboolean">gboolean</link> : Read
"<link linkend="GsfInput--name">name</link>" <link linkend="gchararray">gchararray</link> : Read
"<link linkend="GsfInput--position">position</link>" <link linkend="gint64">gint64</link> : Read
"<link linkend="GsfInput--remaining">remaining</link>" <link linkend="gint64">gint64</link> : Read
"<link linkend="GsfInput--size">size</link>" <link linkend="gint64">gint64</link> : Read
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GsfInput-struct" role="struct"/>GsfInput</title>
<indexterm><primary>GsfInput</primary></indexterm><programlisting>typedef struct _GsfInput GsfInput;</programlisting>
<para>
Class representing an input stream.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-input-read" role="function"/>gsf_input_read ()</title>
<indexterm><primary>gsf_input_read</primary></indexterm><programlisting><link linkend="guint8">guint8</link>const * gsf_input_read (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="size-t">size_t</link> num_bytes,
<link linkend="guint8">guint8</link> *optional_buffer);</programlisting>
<para>
Read at least <parameter>num_bytes</parameter>. Does not change the current position if there
is an error. Will only read if the entire amount can be read. Invalidates
the buffer associated with previous calls to gsf_input_read.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_bytes</parameter> :</term>
<listitem><simpara> number of bytes to read
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>optional_buffer</parameter> :</term>
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link>, or pointer to destination memory area
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> pointer to the buffer or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is an error or 0 bytes are
requested.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-tell" role="function"/>gsf_input_tell ()</title>
<indexterm><primary>gsf_input_tell</primary></indexterm><programlisting><link linkend="gsf-off-t">gsf_off_t</link> gsf_input_tell (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input stream
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current offset in the file.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-seek" role="function"/>gsf_input_seek ()</title>
<indexterm><primary>gsf_input_seek</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_input_seek (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="gsf-off-t">gsf_off_t</link> offset,
<link linkend="GSeekType">GSeekType</link> whence);</programlisting>
<para>
Move the current location in the input stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> target offset
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>whence</parameter> :</term>
<listitem><simpara> determines whether the offset is relative to the beginning or
the end of the stream, or to the current location.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-container" role="function"/>gsf_input_container ()</title>
<indexterm><primary>gsf_input_container</primary></indexterm><programlisting><link linkend="GsfInfile">GsfInfile</link>* gsf_input_container (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input stream
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> but does not add a reference to <parameter>input</parameter>'s container.
Potentially <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-dup" role="function"/>gsf_input_dup ()</title>
<indexterm><primary>gsf_input_dup</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_dup (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
Duplicates input <parameter>src</parameter> leaving the new one at the same offset.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> The input to duplicate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara> optionally <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the duplicate, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-size" role="function"/>gsf_input_size ()</title>
<indexterm><primary>gsf_input_size</primary></indexterm><programlisting><link linkend="gsf-off-t">gsf_off_t</link> gsf_input_size (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
<para>
Looks up and caches the number of bytes in the input</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> The input
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the size or -1 on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-eof" role="function"/>gsf_input_eof ()</title>
<indexterm><primary>gsf_input_eof</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_input_eof (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
<para>
Are we at the end of the file ?</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the input is at the eof.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-remaining" role="function"/>gsf_input_remaining ()</title>
<indexterm><primary>gsf_input_remaining</primary></indexterm><programlisting><link linkend="gsf-off-t">gsf_off_t</link> gsf_input_remaining (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input stream
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of bytes left in the file.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-error-id" role="function"/>gsf_input_error_id ()</title>
<indexterm><primary>gsf_input_error_id</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> gsf_input_error_id (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A utility quark to flag a GError as being an input problem.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-sibling" role="function"/>gsf_input_sibling ()</title>
<indexterm><primary>gsf_input_sibling</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_sibling (<link linkend="GsfInput">GsfInput</link> const *input,
<link linkend="char">char</link> const *name,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-error" role="function"/>gsf_input_error ()</title>
<indexterm><primary>gsf_input_error</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> gsf_input_error (void);</programlisting>
<para>
Deprecated as of GSF 1.12.0; use <link linkend="gsf-input-error-id"><function>gsf_input_error_id()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A utility quark to flag a GError as being an input problem.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-name" role="function"/>gsf_input_name ()</title>
<indexterm><primary>gsf_input_name</primary></indexterm><programlisting><link linkend="char">char</link>const * gsf_input_name (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
<para>
The name of the input stream.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input stream
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>input</parameter>'s name in utf8 form, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if it has no name.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-set-name-from-filename" role="function"/>gsf_input_set_name_from_filename ()</title>
<indexterm><primary>gsf_input_set_name_from_filename</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_input_set_name_from_filename (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="char">char</link> const *filename);</programlisting>
<para>
protected.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> the input stream
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> the (fs-sys encoded) filename
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the assignment was ok.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfInputProxy-struct" role="struct"/>GsfInputProxy</title>
<indexterm><primary>GsfInputProxy</primary></indexterm><programlisting>typedef struct _GsfInputProxy GsfInputProxy;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-input-proxy-new" role="function"/>gsf_input_proxy_new ()</title>
<indexterm><primary>gsf_input_proxy_new</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_proxy_new (<link linkend="GsfInput">GsfInput</link> *source);</programlisting>
<para>
This creates a new proxy to the entire, given input source. See
gsf_input_proxy_new_section for details.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> The underlying data source.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new input object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-proxy-new-section" role="function"/>gsf_input_proxy_new_section ()</title>
<indexterm><primary>gsf_input_proxy_new_section</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_proxy_new_section (<link linkend="GsfInput">GsfInput</link> *source,
<link linkend="gsf-off-t">gsf_off_t</link> offset,
<link linkend="gsf-off-t">gsf_off_t</link> size);</programlisting>
<para>
This creates a new proxy to a section of the given source. The new
object will have its own current position, but any operation on it
can change the source's position.
</para>
<para>
If a proxy to a proxy is created, the intermediate proxy is short-
circuited.
</para>
<para>
This function will ref the source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> The underlying data source.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset</parameter> :</term>
<listitem><simpara> Offset into source for start of section.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> Length of section.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new input object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-copy" role="function"/>gsf_input_copy ()</title>
<indexterm><primary>gsf_input_copy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_input_copy (<link linkend="GsfInput">GsfInput</link> *input,
<link linkend="GsfOutput">GsfOutput</link> *output);</programlisting>
<para>
Copy the contents from <parameter>input</parameter> to <parameter>output</parameter> from their respective
current positions. So if you want to be sure to copy *everything*,
make sure to call gsf_input_seek (input, 0, G_SEEK_SET) and
gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter> :</term>
<listitem><simpara> a non-null <link linkend="GsfInput"><type>GsfInput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>output</parameter> :</term>
<listitem><simpara> a non-null <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on Success
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-uncompress" role="function"/>gsf_input_uncompress ()</title>
<indexterm><primary>gsf_input_uncompress</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>* gsf_input_uncompress (<link linkend="GsfInput">GsfInput</link> *src);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara> stream to be uncompressed.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A stream equivalent to the source stream, but uncompressed if
the source was compressed.
This functions takes ownership of the incoming reference and yields a
new one as its output.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GsfInput--eof"/>The "<literal>eof</literal>" property</title>
<indexterm><primary>GsfInput:eof</primary></indexterm><programlisting> "eof" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>End Of File.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="GsfInput--name"/>The "<literal>name</literal>" property</title>
<indexterm><primary>GsfInput:name</primary></indexterm><programlisting> "name" <link linkend="gchararray">gchararray</link> : Read</programlisting>
<para>The Input's Name.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GsfInput--position"/>The "<literal>position</literal>" property</title>
<indexterm><primary>GsfInput:position</primary></indexterm><programlisting> "position" <link linkend="gint64">gint64</link> : Read</programlisting>
<para>The Output's Current Position.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GsfInput--remaining"/>The "<literal>remaining</literal>" property</title>
<indexterm><primary>GsfInput:remaining</primary></indexterm><programlisting> "remaining" <link linkend="gint64">gint64</link> : Read</programlisting>
<para>Amount of Data Remaining.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="GsfInput--size"/>The "<literal>size</literal>" property</title>
<indexterm><primary>GsfInput:size</primary></indexterm><programlisting> "size" <link linkend="gint64">gint64</link> : Read</programlisting>
<para>The Input's Size.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
</refsect1>
</refentry>
|