RubyGems - gsf - Versions diffs - 3.0.9-x64-mingw32 - Mend

gsf 3.0.9-x64-mingw32

Files changed (166) hide show

data/vendor/local/share/gtk-doc/html/gsf/gsf-Infile-reading-structed-files.html ADDED Viewed

@@ -0,0 +1,397 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GSF Reference Manual: Infile reading structed files</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" 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.20 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</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="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
+                  <a href="#gsf-Infile-reading-structed-files.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
+                  <a href="#gsf-Infile-reading-structed-files.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="sources.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="sources.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="gsf-Outfile-writing-structed-files.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<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"><a name="gsf-Infile-reading-structed-files.top_of_page"></a>Infile reading structed files</span></h2>
+<p>Infile reading structed files</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="gsf-Infile-reading-structed-files.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">int</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Infile-reading-structed-files.html#gsf-infile-num-children" title="gsf_infile_num_children ()">gsf_infile_num_children</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<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> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">char</span> const *
+</td>
+<td class="function_name">
+<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> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<a name="GsfInfile"></a><div class="refsect1">
+<a name="gsf-Infile-reading-structed-files.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody><tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile-struct" title="GsfInfile">GsfInfile</a></td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-Infile-reading-structed-files.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">╰──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
+        <span class="lineart">╰──</span> GsfInfile
+            <span class="lineart">├──</span> <a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle">GsfInfileMSOle</a>
+            <span class="lineart">├──</span> <a class="link" href="gsf-Reading-and-Writing-from-local-files-and-directories.html#GsfInfileStdio">GsfInfileStdio</a>
+            <span class="lineart">├──</span> <a class="link" href="gsf-Zip.html#GsfInfileZip">GsfInfileZip</a>
+            <span class="lineart">╰──</span> <a class="link" href="gsf-blobs.html#GsfStructuredBlob">GsfStructuredBlob</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsf-Infile-reading-structed-files.description"></a><h2>Description</h2>
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsf-Infile-reading-structed-files.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gsf-infile-num-children"></a><h3>gsf_infile_num_children ()</h3>
+<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>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.2.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>infile</p></td>
+<td class="parameter_description"><p>the structured storage</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.2.5"></a><h4>Returns</h4>
+<p> the number of children the storage has, or -1 if the storage can not
+have children.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-infile-child-by-index"></a><h3>gsf_infile_child_by_index ()</h3>
+<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>,
+                           <em class="parameter"><code><span class="type">int</span> i</code></em>);</pre>
+<p>TODO : For 2.0 api will change to include a <span class="type">GError</span>.</p>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.3.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>infile</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>i</p></td>
+<td class="parameter_description"><p>target index</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.3.6"></a><h4>Returns</h4>
+<p> a newly created child which must be unrefed. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-infile-child-by-name"></a><h3>gsf_infile_child_by_name ()</h3>
+<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>,
+                          <em class="parameter"><code><span class="type">char</span> const *name</code></em>);</pre>
+<p>The function returns a named child of the given infile.  This only
+works for an immediate child.  If you need to go several levels
+down use gsf_infile_child_by_aname, for example.</p>
+<p>TODO : For 2.0 api will change to include a <span class="type">GError</span>.</p>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.4.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>infile</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>target name</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.4.7"></a><h4>Returns</h4>
+<p> a newly created child which must be
+unrefed. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-infile-child-by-vname"></a><h3>gsf_infile_child_by_vname ()</h3>
+<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>,
+                           <em class="parameter"><code>...</code></em>);</pre>
+<p>Apart from the way arguments are specified, this is the same as
+gsf_infile_child_by_aname.  Please see the documentation there.</p>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.5.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>infile</p></td>
+<td class="parameter_description"><p>a <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>...</p></td>
+<td class="parameter_description"><p>A <code class="literal">NULL</code> terminated list of names</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.5.6"></a><h4>Returns</h4>
+<p> a newly created child which must be unrefed. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-infile-child-by-aname"></a><h3>gsf_infile_child_by_aname ()</h3>
+<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>,
+                           <em class="parameter"><code><span class="type">char</span> const *names[]</code></em>);</pre>
+<p>This function finds a child that is several directory levels down
+the tree.  If, for example, the names "foo", "bar", and "baz" are
+given, then this function first finds the "foo" directory in the
+root infile, then locates "bar" within that directory, and finally
+locates "baz" within that and returns the "baz" child.  In other
+words, this function finds the "foo/bar/baz" child.</p>
+<p>New in 1.14.9.</p>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.6.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>infile</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>names</p></td>
+<td class="parameter_description"><p>A <code class="literal">NULL</code> terminated array of names (e.g. from g_strsplit)</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.6.7"></a><h4>Returns</h4>
+<p> a newly created child which must be unrefed. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-infile-child-by-vaname"></a><h3>gsf_infile_child_by_vaname ()</h3>
+<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>,
+                            <em class="parameter"><code><span class="type">va_list</span> names</code></em>);</pre>
+<p>Apart from argument types, this is the same as gsf_infile_child_by_aname.
+Please see the documentation there.
+New in 1.14.9.</p>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.7.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>infile</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>names</p></td>
+<td class="parameter_description"><p>A <code class="literal">NULL</code> terminated array of names (e.g. from g_strsplit)</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.7.6"></a><h4>Returns</h4>
+<p> a newly created child which must be unrefed. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-infile-name-by-index"></a><h3>gsf_infile_name_by_index ()</h3>
+<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>,
+                          <em class="parameter"><code><span class="type">int</span> i</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.8.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>infile</p></td>
+<td class="parameter_description"><p>An <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>i</p></td>
+<td class="parameter_description"><p>zero-based index of child to find.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.4.2.8.8.5"></a><h4>Returns</h4>
+<p> the utf8 encoded name of the <em class="parameter"><code>i</code></em>
+-th child. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-Infile-reading-structed-files.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GsfInfile-struct"></a><h3>GsfInfile</h3>
+<pre class="programlisting">typedef struct _GsfInfile GsfInfile;</pre>
+<p>
+</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>