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.
271 lines
10 KiB
271 lines
10 KiB
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>Infile reading structed files</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="sources.html" title="Stream Sources">
|
|
<link rel="prev" href="sources.html" title="Stream Sources">
|
|
<link rel="next" href="gsf-Outfile-writing-structed-files.html" title="Outfile writing structed files">
|
|
<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 I. GSF Overview">
|
|
<link rel="part" href="api.html" title="Part II. 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="sources.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="sources.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="gsf-Outfile-writing-structed-files.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-Infile-reading-structed-files"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2><span class="refentrytitle">Infile reading structed files</span></h2>
|
|
<p>Infile reading structed files — </p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<a name="GsfInfile"></a><pre class="synopsis">
|
|
|
|
|
|
|
|
<a href="gsf-Infile-reading-structed-files.html#GsfInfile-struct">GsfInfile</a>;
|
|
int <a href="gsf-Infile-reading-structed-files.html#gsf-infile-num-children">gsf_infile_num_children</a> (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile);
|
|
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* <a href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-index">gsf_infile_child_by_index</a> (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
int i);
|
|
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* <a href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-name">gsf_infile_child_by_name</a> (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
char const *name);
|
|
<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* <a href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-vname">gsf_infile_child_by_vname</a> (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
char const *name,
|
|
...);
|
|
charconst * <a href="gsf-Infile-reading-structed-files.html#gsf-infile-name-by-index">gsf_infile_name_by_index</a> (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
int i);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2526060"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
GObject
|
|
+----<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
|
|
+----GsfInfile
|
|
+----<a href="gsf-MS-OLE2.html#GsfInfileMSOle">GsfInfileMSOle</a>
|
|
+----<a href="gsf-Reading-and-Writing-from-local-files-and-directories.html#GsfInfileStdio">GsfInfileStdio</a>
|
|
+----<a href="gsf-Zip.html#GsfInfileZip">GsfInfileZip</a>
|
|
+----<a href="gsf-Structured-Blobs.html#GsfStructuredBlob">GsfStructuredBlob</a>
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2526120"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2526130"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2526136"></a><h3>
|
|
<a name="GsfInfile-struct"></a>GsfInfile</h3>
|
|
<a class="indexterm" name="id2526146"></a><pre class="programlisting">typedef struct _GsfInfile GsfInfile;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2526161"></a><h3>
|
|
<a name="gsf-infile-num-children"></a>gsf_infile_num_children ()</h3>
|
|
<a class="indexterm" name="id2526171"></a><pre class="programlisting">int gsf_infile_num_children (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile);</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>infile</code></em> :</span></td>
|
|
<td> the structured storage
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>the number of children the storage has, or -1 if the storage can not
|
|
have children.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2526232"></a><h3>
|
|
<a name="gsf-infile-child-by-index"></a>gsf_infile_child_by_index ()</h3>
|
|
<a class="indexterm" name="id2526244"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* gsf_infile_child_by_index (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
int i);</pre>
|
|
<p>
|
|
TODO : For 2.0 api will change to include a GError.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>infile</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>i</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>a newly created child which must be unrefed.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2526325"></a><h3>
|
|
<a name="gsf-infile-child-by-name"></a>gsf_infile_child_by_name ()</h3>
|
|
<a class="indexterm" name="id2526335"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* gsf_infile_child_by_name (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
char const *name);</pre>
|
|
<p>
|
|
TODO : For 2.0 api will change to include a GError.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>infile</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>a newly created child which must be unrefed.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2526418"></a><h3>
|
|
<a name="gsf-infile-child-by-vname"></a>gsf_infile_child_by_vname ()</h3>
|
|
<a class="indexterm" name="id2526430"></a><pre class="programlisting"><a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>* gsf_infile_child_by_vname (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
char const *name,
|
|
...);</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>infile</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> A <code class="literal">null</code> terminated list of names
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
|
|
<td> the rest of the names
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>a newly created child which must be unrefed.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2526532"></a><h3>
|
|
<a name="gsf-infile-name-by-index"></a>gsf_infile_name_by_index ()</h3>
|
|
<a class="indexterm" name="id2526543"></a><pre class="programlisting">charconst * gsf_infile_name_by_index (<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a> *infile,
|
|
int i);</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>infile</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>i</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td>the utf8 encoded name of the <em class="parameter"><code>i</code></em>-th child
|
|
NOTE : DO NOT FREE THE STRING
|
|
</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="sources.html"><b><< Stream Sources</b></a></td>
|
|
<td align="right"><a accesskey="n" href="gsf-Outfile-writing-structed-files.html"><b>Outfile writing structed files >></b></a></td>
|
|
</tr></table>
|
|
</body>
|
|
</html>
|