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.
gnucash/lib/libgsf-1.12.3/doc/html/gsf-Structured-Blobs.html

148 lines
5.9 KiB

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Structured Blobs</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="parsers.html" title="Stream Parsers">
<link rel="prev" href="gsf-GsfClipData.html" title="GsfClipData">
<link rel="next" href="misc.html" title="Miscellaneous">
<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&#160;I.&#160;GSF Overview">
<link rel="part" href="api.html" title="Part&#160;II.&#160;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-GsfClipData.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="parsers.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="misc.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-Structured-Blobs"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">Structured Blobs</span></h2>
<p>Structured Blobs &#8212; </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GsfStructuredBlob"></a><pre class="synopsis">
<a href="gsf-Structured-Blobs.html#GsfStructuredBlob-struct">GsfStructuredBlob</a>;
gboolean <a href="gsf-Structured-Blobs.html#gsf-structured-blob-write">gsf_structured_blob_write</a> (<a href="gsf-Structured-Blobs.html#GsfStructuredBlob">GsfStructuredBlob</a> *blob,
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a> *container);
<a href="gsf-Structured-Blobs.html#GsfStructuredBlob">GsfStructuredBlob</a>* <a href="gsf-Structured-Blobs.html#gsf-structured-blob-read">gsf_structured_blob_read</a> (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *input);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2577404"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
+----<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
+----GsfStructuredBlob
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2577438"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2577447"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2577453"></a><h3>
<a name="GsfStructuredBlob-struct"></a>GsfStructuredBlob</h3>
<a class="indexterm" name="id2577464"></a><pre class="programlisting">typedef struct _GsfStructuredBlob GsfStructuredBlob;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2577480"></a><h3>
<a name="gsf-structured-blob-write"></a>gsf_structured_blob_write ()</h3>
<a class="indexterm" name="id2577491"></a><pre class="programlisting">gboolean gsf_structured_blob_write (<a href="gsf-Structured-Blobs.html#GsfStructuredBlob">GsfStructuredBlob</a> *blob,
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a> *container);</pre>
<p>
Dumps structured blob <em class="parameter"><code>blob</code></em> onto the <em class="parameter"><code>container</code></em>. Will fail if the output is
not an Outfile and blob has multiple streams.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>blob</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>container</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>: TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2577586"></a><h3>
<a name="gsf-structured-blob-read"></a>gsf_structured_blob_read ()</h3>
<a class="indexterm" name="id2577596"></a><pre class="programlisting"><a href="gsf-Structured-Blobs.html#GsfStructuredBlob">GsfStructuredBlob</a>* gsf_structured_blob_read (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *input);</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>input</code></em>&#160;:</span></td>
<td> An input (potentially a GsfInfile) holding the blob
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>a freshly created tree of blobs
</td>
</tr>
</tbody>
</table></div>
</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-GsfClipData.html"><b>&lt;&lt;&#160;GsfClipData</b></a></td>
<td align="right"><a accesskey="n" href="misc.html"><b>Miscellaneous&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>