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.
161 lines
7.0 KiB
161 lines
7.0 KiB
<refentry id="gsf-Outfile-writing-structed-files">
|
|
<refmeta>
|
|
<refentrytitle>Outfile writing structed files</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>GSF Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>Outfile writing structed files</refname><refpurpose></refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
<anchor id="GsfOutfile"/>
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GsfOutfile-struct">GsfOutfile</link>;
|
|
<link linkend="GsfOutput">GsfOutput</link>* <link linkend="gsf-outfile-new-child">gsf_outfile_new_child</link> (<link linkend="GsfOutfile">GsfOutfile</link> *outfile,
|
|
<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_dir);
|
|
<link linkend="GsfOutput">GsfOutput</link>* <link linkend="gsf-outfile-new-child-full">gsf_outfile_new_child_full</link> (<link linkend="GsfOutfile">GsfOutfile</link> *outfile,
|
|
<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_dir,
|
|
<link linkend="char">char</link> const *first_property_name,
|
|
...);
|
|
<link linkend="GsfOutput">GsfOutput</link>* <link linkend="gsf-outfile-new-child-varg">gsf_outfile_new_child_varg</link> (<link linkend="GsfOutfile">GsfOutfile</link> *outfile,
|
|
<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_dir,
|
|
<link linkend="char">char</link> const *first_property_name,
|
|
<link linkend="va-list">va_list</link> args);
|
|
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GsfOutput">GsfOutput</link>
|
|
+----GsfOutfile
|
|
+----<link linkend="GsfOutfileMSOle">GsfOutfileMSOle</link>
|
|
+----<link linkend="GsfOutfileStdio">GsfOutfileStdio</link>
|
|
+----<link linkend="GsfOutfileZip">GsfOutfileZip</link>
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GsfOutfile-struct"/>GsfOutfile</title>
|
|
<indexterm><primary>GsfOutfile</primary></indexterm><programlisting>typedef struct _GsfOutfile GsfOutfile;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-outfile-new-child"/>gsf_outfile_new_child ()</title>
|
|
<indexterm><primary>gsf_outfile_new_child</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>* gsf_outfile_new_child (<link linkend="GsfOutfile">GsfOutfile</link> *outfile,
|
|
<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_dir);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>outfile</parameter> :</term>
|
|
<listitem><simpara> A <link linkend="GsfOutfile"><type>GsfOutfile</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The name of the new child to create
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>is_dir</parameter> :</term>
|
|
<listitem><simpara> TRUE to create a directory, FALSE to create a plain file
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a newly created child
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-outfile-new-child-full"/>gsf_outfile_new_child_full ()</title>
|
|
<indexterm><primary>gsf_outfile_new_child_full</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>* gsf_outfile_new_child_full (<link linkend="GsfOutfile">GsfOutfile</link> *outfile,
|
|
<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_dir,
|
|
<link linkend="char">char</link> const *first_property_name,
|
|
...);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>outfile</parameter> :</term>
|
|
<listitem><simpara> A <link linkend="GsfOutfile"><type>GsfOutfile</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The name of the new child to create
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>is_dir</parameter> :</term>
|
|
<listitem><simpara> TRUE to create a directory, FALSE to create a plain file
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>first_property_name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>...</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a newly created child
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gsf-outfile-new-child-varg"/>gsf_outfile_new_child_varg ()</title>
|
|
<indexterm><primary>gsf_outfile_new_child_varg</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>* gsf_outfile_new_child_varg (<link linkend="GsfOutfile">GsfOutfile</link> *outfile,
|
|
<link linkend="char">char</link> const *name,
|
|
<link linkend="gboolean">gboolean</link> is_dir,
|
|
<link linkend="char">char</link> const *first_property_name,
|
|
<link linkend="va-list">va_list</link> args);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>outfile</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>is_dir</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>first_property_name</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>args</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|