File: gsf-Infile-reading-structed-files.html

package info (click to toggle)
libgsf 1.14.3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 4,644 kB
  • ctags: 3,140
  • sloc: ansic: 16,511; sh: 9,076; xml: 6,155; makefile: 454; perl: 35; python: 13
file content (264 lines) | stat: -rw-r--r-- 10,661 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<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.71.0">
<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.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="intro.html" title="Part&#160;I.&#160;GSF: Introduction">
<link rel="part" href="history.html" title="Part&#160;II.&#160;GSF: History">
<link rel="part" href="dependencies.html" title="Part&#160;III.&#160;GSF: Dependencies">
<link rel="part" href="gsf-users.html" title="Part&#160;IV.&#160;Projects using GSF">
<link rel="part" href="api.html" title="Part&#160;V.&#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" id="top" 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>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2558095" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2558327" class="shortcut">Description</a>
                  &#160;|&#160;
                  <a href="#id2558262" class="shortcut">Object Hierarchy</a></nobr></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>
<a name="id2558095"></a><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="id2558262"></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-blobs.html#GsfStructuredBlob">GsfStructuredBlob</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2558327"></a><h2>Description</h2>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2558342"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2558352"></a><h3>
<a name="GsfInfile-struct"></a>GsfInfile</h3>
<a class="indexterm" name="id2558365"></a><pre class="programlisting">typedef struct _GsfInfile GsfInfile;</pre>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558380"></a><h3>
<a name="gsf-infile-num-children"></a>gsf_infile_num_children ()</h3>
<a class="indexterm" name="id2558392"></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>&#160;:</span></td>
<td> the structured storage
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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="id2558453"></a><h3>
<a name="gsf-infile-child-by-index"></a>gsf_infile_child_by_index ()</h3>
<a class="indexterm" name="id2558467"></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>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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="id2558548"></a><h3>
<a name="gsf-infile-child-by-name"></a>gsf_infile_child_by_name ()</h3>
<a class="indexterm" name="id2558561"></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>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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="id2558643"></a><h3>
<a name="gsf-infile-child-by-vname"></a>gsf_infile_child_by_vname ()</h3>
<a class="indexterm" name="id2558657"></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>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</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>&#160;:</span></td>
<td> the rest of the names
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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="id2558764"></a><h3>
<a name="gsf-infile-name-by-index"></a>gsf_infile_name_by_index ()</h3>
<a class="indexterm" name="id2558777"></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>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>i</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>the utf8 encoded name of the <em class="parameter"><code>i</code></em>-th child
<span class="emphasis"><em>DO NOT FREE THE STRING.</em></span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>