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.
100 lines
3.3 KiB
100 lines
3.3 KiB
<refentry id="gsf-Structured-Blobs">
|
|
<refmeta>
|
|
<refentrytitle>Structured Blobs</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>GSF Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>Structured Blobs</refname><refpurpose></refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
<anchor id="GsfStructuredBlob"/>
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GsfStructuredBlob-struct">GsfStructuredBlob</link>;
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gsf-structured-blob-write">gsf_structured_blob_write</link> (<link linkend="GsfStructuredBlob">GsfStructuredBlob</link> *blob,
|
|
<link linkend="GsfOutfile">GsfOutfile</link> *container);
|
|
<link linkend="GsfStructuredBlob">GsfStructuredBlob</link>* <link linkend="gsf-structured-blob-read">gsf_structured_blob_read</link> (<link linkend="GsfInput">GsfInput</link> *input);
|
|
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GsfInput">GsfInput</link>
|
|
+----<link linkend="GsfInfile">GsfInfile</link>
|
|
+----GsfStructuredBlob
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GsfStructuredBlob-struct"/>GsfStructuredBlob</title>
|
|
<indexterm><primary>GsfStructuredBlob</primary></indexterm><programlisting>typedef struct _GsfStructuredBlob GsfStructuredBlob;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-structured-blob-write"/>gsf_structured_blob_write ()</title>
|
|
<indexterm><primary>gsf_structured_blob_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gsf_structured_blob_write (<link linkend="GsfStructuredBlob">GsfStructuredBlob</link> *blob,
|
|
<link linkend="GsfOutfile">GsfOutfile</link> *container);</programlisting>
|
|
<para>
|
|
Dumps structured blob <parameter>blob</parameter> onto the <parameter>container</parameter>. Will fail if the output is
|
|
not an Outfile and blob has multiple streams.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>blob</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>container</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>: TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-structured-blob-read"/>gsf_structured_blob_read ()</title>
|
|
<indexterm><primary>gsf_structured_blob_read</primary></indexterm><programlisting><link linkend="GsfStructuredBlob">GsfStructuredBlob</link>* gsf_structured_blob_read (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>input</parameter> :</term>
|
|
<listitem><simpara> An input (potentially a GsfInfile) holding the blob
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a freshly created tree of blobs
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|