doc/html/gsf-Infile-reading-structed-files.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Infile reading structed files</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GSF Reference Manual">
   8 <link rel="up" href="sources.html" title="Stream Sources">
   9 <link rel="prev" href="sources.html" title="Stream Sources">
  10 <link rel="next" href="gsf-Outfile-writing-structed-files.html" title="Outfile writing structed files">
  11 <meta name="generator" content="GTK-Doc V1.14 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="sources.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="sources.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GSF Reference Manual</th>
  21 <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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gsf-Infile-reading-structed-files.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gsf-Infile-reading-structed-files.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gsf-Infile-reading-structed-files.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry" title="Infile reading structed files">
  32 <a name="gsf-Infile-reading-structed-files"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="gsf-Infile-reading-structed-files.top_of_page"></a>Infile reading structed files</span></h2>
  36 <p>Infile reading structed files</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv" title="Synopsis">
  41 <a name="gsf-Infile-reading-structed-files.synopsis"></a><h2>Synopsis</h2>
  42 <a name="GsfInfile"></a><pre class="synopsis">                    <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile-struct" title="GsfInfile">GsfInfile</a>;
  43 <span class="returnvalue">int</span>                 <a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-num-children" title="gsf_infile_num_children ()">gsf_infile_num_children</a>             (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>);
  44 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          <a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-index" title="gsf_infile_child_by_index ()">gsf_infile_child_by_index</a>           (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
  45                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>);
  46 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          <a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-name" title="gsf_infile_child_by_name ()">gsf_infile_child_by_name</a>            (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
  47                                                          <em class="parameter"><code><span class="type">char</span> const *name</code></em>);
  48 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          <a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-vname" title="gsf_infile_child_by_vname ()">gsf_infile_child_by_vname</a>           (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
  49                                                          <em class="parameter"><code>...</code></em>);
  50 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          <a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-aname" title="gsf_infile_child_by_aname ()">gsf_infile_child_by_aname</a>           (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
  51                                                          <em class="parameter"><code><span class="type">char</span> const *names[]</code></em>);
  52 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          <a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-child-by-vaname" title="gsf_infile_child_by_vaname ()">gsf_infile_child_by_vaname</a>          (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
  53                                                          <em class="parameter"><code><span class="type">va_list</span> names</code></em>);
  54 <span class="returnvalue">char</span> const *        <a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-name-by-index" title="gsf_infile_name_by_index ()">gsf_infile_name_by_index</a>            (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
  55                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>);
  56 </pre>
  57 </div>
  58 <div class="refsect1" title="Object Hierarchy">
  59 <a name="gsf-Infile-reading-structed-files.object-hierarchy"></a><h2>Object Hierarchy</h2>
  60 <pre class="synopsis">
  61   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  62    +----<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
  63          +----GsfInfile
  64                +----<a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle">GsfInfileMSOle</a>
  65                +----<a class="link" href="gsf-Reading-and-Writing-from-local-files-and-directories.html#GsfInfileStdio">GsfInfileStdio</a>
  66                +----<a class="link" href="gsf-Zip.html#GsfInfileZip">GsfInfileZip</a>
  67                +----<a class="link" href="gsf-blobs.html#GsfStructuredBlob">GsfStructuredBlob</a>
  68 </pre>
  69 </div>
  70 <div class="refsect1" title="Description">
  71 <a name="gsf-Infile-reading-structed-files.description"></a><h2>Description</h2>
  72 <p>
  73 </p>
  74 </div>
  75 <div class="refsect1" title="Details">
  76 <a name="gsf-Infile-reading-structed-files.details"></a><h2>Details</h2>
  77 <div class="refsect2" title="GsfInfile">
  78 <a name="GsfInfile-struct"></a><h3>GsfInfile</h3>
  79 <pre class="programlisting">typedef struct _GsfInfile GsfInfile;</pre>
  80 <p>
  81 </p>
  82 </div>
  83 <hr>
  84 <div class="refsect2" title="gsf_infile_num_children ()">
  85 <a name="gsf-infile-num-children"></a><h3>gsf_infile_num_children ()</h3>
  86 <pre class="programlisting"><span class="returnvalue">int</span>                 gsf_infile_num_children             (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>);</pre>
  87 <div class="variablelist"><table border="0">
  88 <col align="left" valign="top">
  89 <tbody>
  90 <tr>
  91 <td><p><span class="term"><em class="parameter"><code>infile</code></em> :</span></p></td>
  92 <td>the structured storage
  93 </td>
  94 </tr>
  95 <tr>
  96 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  97 <td> the number of children the storage has, or -1 if the storage can not
  98         have children.
  99 </td>
 100 </tr>
 101 </tbody>
 102 </table></div>
 103 </div>
 104 <hr>
 105 <div class="refsect2" title="gsf_infile_child_by_index ()">
 106 <a name="gsf-infile-child-by-index"></a><h3>gsf_infile_child_by_index ()</h3>
 107 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          gsf_infile_child_by_index           (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
 108                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>);</pre>
 109 <p>
 110 TODO : For 2.0 api will change to include a GError.
 111 </p>
 112 <div class="variablelist"><table border="0">
 113 <col align="left" valign="top">
 114 <tbody>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>infile</code></em> :</span></p></td>
 117 <td>
 118 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a>
 119 </td>
 120 </tr>
 121 <tr>
 122 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
 123 <td>target index
 124 </td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 128 <td> a newly created child which must be unrefed.
 129 </td>
 130 </tr>
 131 </tbody>
 132 </table></div>
 133 </div>
 134 <hr>
 135 <div class="refsect2" title="gsf_infile_child_by_name ()">
 136 <a name="gsf-infile-child-by-name"></a><h3>gsf_infile_child_by_name ()</h3>
 137 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          gsf_infile_child_by_name            (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
 138                                                          <em class="parameter"><code><span class="type">char</span> const *name</code></em>);</pre>
 139 <p>
 140 TODO : For 2.0 api will change to include a GError.
 141 </p>
 142 <div class="variablelist"><table border="0">
 143 <col align="left" valign="top">
 144 <tbody>
 145 <tr>
 146 <td><p><span class="term"><em class="parameter"><code>infile</code></em> :</span></p></td>
 147 <td>
 148 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a>
 149 </td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 153 <td>target name
 154 </td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 158 <td> a newly created child which must be unrefed.
 159 </td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 <hr>
 165 <div class="refsect2" title="gsf_infile_child_by_vname ()">
 166 <a name="gsf-infile-child-by-vname"></a><h3>gsf_infile_child_by_vname ()</h3>
 167 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          gsf_infile_child_by_vname           (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
 168                                                          <em class="parameter"><code>...</code></em>);</pre>
 169 <div class="variablelist"><table border="0">
 170 <col align="left" valign="top">
 171 <tbody>
 172 <tr>
 173 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 174 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated list of names
 175 </td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 179 <td> a newly created child which must be unrefed.
 180 </td>
 181 </tr>
 182 </tbody>
 183 </table></div>
 184 </div>
 185 <hr>
 186 <div class="refsect2" title="gsf_infile_child_by_aname ()">
 187 <a name="gsf-infile-child-by-aname"></a><h3>gsf_infile_child_by_aname ()</h3>
 188 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          gsf_infile_child_by_aname           (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
 189                                                          <em class="parameter"><code><span class="type">char</span> const *names[]</code></em>);</pre>
 190 <p>
 191 New in 1.14.9.
 192 </p>
 193 <div class="variablelist"><table border="0">
 194 <col align="left" valign="top">
 195 <tbody>
 196 <tr>
 197 <td><p><span class="term"><em class="parameter"><code>infile</code></em> :</span></p></td>
 198 <td>
 199 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a>
 200 </td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td>
 204 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of names (e.g. from g_strsplit)
 205 </td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 209 <td> a newly created child which must be unrefed.
 210 </td>
 211 </tr>
 212 </tbody>
 213 </table></div>
 214 </div>
 215 <hr>
 216 <div class="refsect2" title="gsf_infile_child_by_vaname ()">
 217 <a name="gsf-infile-child-by-vaname"></a><h3>gsf_infile_child_by_vaname ()</h3>
 218 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *          gsf_infile_child_by_vaname          (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
 219                                                          <em class="parameter"><code><span class="type">va_list</span> names</code></em>);</pre>
 220 <p>
 221 New in 1.14.9.
 222 </p>
 223 <div class="variablelist"><table border="0">
 224 <col align="left" valign="top">
 225 <tbody>
 226 <tr>
 227 <td><p><span class="term"><em class="parameter"><code>infile</code></em> :</span></p></td>
 228 <td>
 229 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a>
 230 </td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td>
 234 <td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated array of names (e.g. from g_strsplit)
 235 </td>
 236 </tr>
 237 <tr>
 238 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 239 <td> a newly created child which must be unrefed.
 240 </td>
 241 </tr>
 242 </tbody>
 243 </table></div>
 244 </div>
 245 <hr>
 246 <div class="refsect2" title="gsf_infile_name_by_index ()">
 247 <a name="gsf-infile-name-by-index"></a><h3>gsf_infile_name_by_index ()</h3>
 248 <pre class="programlisting"><span class="returnvalue">char</span> const *        gsf_infile_name_by_index            (<em class="parameter"><code><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *infile</code></em>,
 249                                                          <em class="parameter"><code><span class="type">int</span> i</code></em>);</pre>
 250 <div class="variablelist"><table border="0">
 251 <col align="left" valign="top">
 252 <tbody><tr>
 253 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 254 <td> the utf8 encoded name of the <em class="parameter"><code>i</code></em>-th child
 255         <span class="emphasis"><em>DO NOT FREE THE STRING.</em></span>
 256 </td>
 257 </tr></tbody>
 258 </table></div>
 259 </div>
 260 </div>
 261 </div>
 262 <div class="footer">
 263 <hr>
 264           Generated by GTK-Doc V1.14</div>
 265 </body>
 266 </html>