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

gsf 3.0.9-x86-mingw32

Files changed (166) hide show

data/vendor/local/share/gtk-doc/html/gsf/gsf-MS-OLE2.html ADDED

@@ -0,0 +1,894 @@
+<!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: MS OLE2</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="parsers.html" title="Stream Parsers">
+<link rel="prev" href="gsf-Compression.html" title="Compression">
+<link rel="next" href="gsf-metadata.html" title="metadata">
+<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-MS-OLE2.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
+                  <a href="#gsf-MS-OLE2.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
+                  <a href="#gsf-MS-OLE2.properties" class="shortcut">Properties</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="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="gsf-Compression.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="gsf-metadata.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="gsf-MS-OLE2"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gsf-MS-OLE2.top_of_page"></a>MS OLE2</span></h2>
+<p>MS OLE2</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="gsf-MS-OLE2.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">
+<a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-infile-msole-new" title="gsf_infile_msole_new ()">gsf_infile_msole_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-infile-msole-get-class-id" title="gsf_infile_msole_get_class_id ()">gsf_infile_msole_get_class_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-outfile-msole-new" title="gsf_outfile_msole_new ()">gsf_outfile_msole_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-outfile-msole-new-full" title="gsf_outfile_msole_new_full ()">gsf_outfile_msole_new_full</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-outfile-msole-set-class-id" title="gsf_outfile_msole_set_class_id ()">gsf_outfile_msole_set_class_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GError</span> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-metadata-read" title="gsf_msole_metadata_read ()">gsf_msole_metadata_read</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-metadata-write" title="gsf_msole_metadata_write ()">gsf_msole_metadata_write</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GIConv</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-iconv-open-codepages-for-export" title="gsf_msole_iconv_open_codepages_for_export ()">gsf_msole_iconv_open_codepages_for_export</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GIConv</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-iconv-open-codepage-for-import" title="gsf_msole_iconv_open_codepage_for_import ()">gsf_msole_iconv_open_codepage_for_import</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GIConv</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-iconv-open-for-export" title="gsf_msole_iconv_open_for_export ()">gsf_msole_iconv_open_for_export</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GIConv</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-iconv-open-codepage-for-export" title="gsf_msole_iconv_open_codepage_for_export ()">gsf_msole_iconv_open_codepage_for_export</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GIConv</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-iconv-open-for-import" title="gsf_msole_iconv_open_for_import ()">gsf_msole_iconv_open_for_import</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">int</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-iconv-win-codepage" title="gsf_msole_iconv_win_codepage ()">gsf_msole_iconv_win_codepage</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">guint</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-codepage-to-lid" title="gsf_msole_codepage_to_lid ()">gsf_msole_codepage_to_lid</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">int</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-lid-to-codepage" title="gsf_msole_lid_to_codepage ()">gsf_msole_lid_to_codepage</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gchar</span> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-lid-to-codepage-str" title="gsf_msole_lid_to_codepage_str ()">gsf_msole_lid_to_codepage_str</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">guint</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-lid-for-language" title="gsf_msole_lid_for_language ()">gsf_msole_lid_for_language</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-MS-OLE2.html#gsf-msole-language-for-lid" title="gsf_msole_language_for_lid ()">gsf_msole_language_for_lid</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GByteArray</span> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-MS-OLE2.html#gsf-msole-inflate" title="gsf_msole_inflate ()">gsf_msole_inflate</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-MS-OLE2.properties"></a><h2>Properties</h2>
+<div class="informaltable"><table border="0">
+<colgroup>
+<col width="150px" class="properties_type">
+<col width="300px" class="properties_name">
+<col width="200px" class="properties_flags">
+</colgroup>
+<tbody>
+<tr>
+<td class="property_type"><span class="type">guint</span></td>
+<td class="property_name"><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle--big-block-size" title="The “big-block-size” property">big-block-size</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type">
+<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</td>
+<td class="property_name"><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle--sink" title="The “sink” property">sink</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">guint</span></td>
+<td class="property_name"><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle--small-block-size" title="The “small-block-size” property">small-block-size</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<a name="GsfInfileMSOle"></a><a name="GsfOutfileMSOle"></a><div class="refsect1">
+<a name="gsf-MS-OLE2.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-MS-OLE2.html#GsfInfileMSOle-struct" title="GsfInfileMSOle">GsfInfileMSOle</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle-struct" title="GsfOutfileMSOle">GsfOutfileMSOle</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-MS-OLE2.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>   <span class="lineart">╰──</span> <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
+    <span class="lineart">│</span>       <span class="lineart">╰──</span> GsfInfileMSOle
+    <span class="lineart">╰──</span> <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
+        <span class="lineart">╰──</span> <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
+            <span class="lineart">╰──</span> GsfOutfileMSOle
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsf-MS-OLE2.description"></a><h2>Description</h2>
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsf-MS-OLE2.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gsf-infile-msole-new"></a><h3>gsf_infile_msole_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *
+gsf_infile_msole_new (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
+                      <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<p>Opens the root directory of an MS OLE file.</p>
+<div class="note">This adds a reference to <em class="parameter"><code>source</code></em>.</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.2.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>source</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p>optional place to store an error</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.2.7"></a><h4>Returns</h4>
+<p> the new ole file handler</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-infile-msole-get-class-id"></a><h3>gsf_infile_msole_get_class_id ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_infile_msole_get_class_id (<em class="parameter"><code><a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle"><span class="type">GsfInfileMSOle</span></a> const *ole</code></em>,
+                               <em class="parameter"><code><span class="type">guint8</span> *res</code></em>);</pre>
+<p>Retrieves the 16 byte indentifier (often a GUID in MS Windows apps)
+stored within the directory associated with <em class="parameter"><code>ole</code></em>
+ and stores it in <em class="parameter"><code>res</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.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>ole</p></td>
+<td class="parameter_description"><p>a <a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle"><span class="type">GsfInfileMSOle</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>res</p></td>
+<td class="parameter_description"><p>16 byte identifier (often a GUID in MS Windows apps)</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.3.6"></a><h4>Returns</h4>
+<p> TRUE on success</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-outfile-msole-new"></a><h3>gsf_outfile_msole_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
+gsf_outfile_msole_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>);</pre>
+<p>Creates the root directory of an MS OLE file and manages the addition of
+children.</p>
+<div class="note">This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.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>sink</p></td>
+<td class="parameter_description"><p>a <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the OLE2 file</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.4.7"></a><h4>Returns</h4>
+<p> the new ole file handler.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-outfile-msole-new-full"></a><h3>gsf_outfile_msole_new_full ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
+gsf_outfile_msole_new_full (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
+                            <em class="parameter"><code><span class="type">guint</span> bb_size</code></em>,
+                            <em class="parameter"><code><span class="type">guint</span> sb_size</code></em>);</pre>
+<p>Creates the root directory of an MS OLE file and manages the addition of
+children.</p>
+<div class="note">This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.5.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>sink</p></td>
+<td class="parameter_description"><p>a <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the OLE2 file.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>bb_size</p></td>
+<td class="parameter_description"><p>size of large blocks.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>sb_size</p></td>
+<td class="parameter_description"><p>size of small blocks.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.5.7"></a><h4>Returns</h4>
+<p> the new ole file handler.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-outfile-msole-set-class-id"></a><h3>gsf_outfile_msole_set_class_id ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_outfile_msole_set_class_id (<em class="parameter"><code><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle"><span class="type">GsfOutfileMSOle</span></a> *ole</code></em>,
+                                <em class="parameter"><code><span class="type">guint8</span> const *clsid</code></em>);</pre>
+<p>Write <em class="parameter"><code>clsid</code></em>
+ to the directory associated with <em class="parameter"><code>ole</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.6.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>ole</p></td>
+<td class="parameter_description"><p>a <a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle"><span class="type">GsfOutfileMSOle</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>clsid</p></td>
+<td class="parameter_description"><p> Identifier (often a GUID in MS Windows apps). </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> fixed-size=16]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.6.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> on success.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-metadata-read"></a><h3>gsf_msole_metadata_read ()</h3>
+<pre class="programlisting"><span class="returnvalue">GError</span> *
+gsf_msole_metadata_read (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *in</code></em>,
+                         <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *accum</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">gsf_msole_metadata_read</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
+<p>, use gsf_doc_meta_data_read_from_msole</p>
+</div>
+<p>Read a stream formated as a set of MS OLE properties from <em class="parameter"><code>in</code></em>
+ and store the
+results in <em class="parameter"><code>accum</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.7.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>in</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>accum</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.7.7"></a><h4>Returns</h4>
+<p> A <span class="type">GError</span> if there was an error. </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-msole-metadata-write"></a><h3>gsf_msole_metadata_write ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_msole_metadata_write (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *out</code></em>,
+                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta_data</code></em>,
+                          <em class="parameter"><code><span class="type">gboolean</span> doc_not_component</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">gsf_msole_metadata_write</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
+<p>, use gsf_doc_meta_data_write_to_msole</p>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.8.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>out</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>meta_data</p></td>
+<td class="parameter_description"><p><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>doc_not_component</p></td>
+<td class="parameter_description"><p>a kludge to differentiate DocumentSummary from Summary</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.8.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> on success;</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-iconv-open-codepages-for-export"></a><h3>gsf_msole_iconv_open_codepages_for_export ()</h3>
+<pre class="programlisting"><span class="returnvalue">GIConv</span>
+gsf_msole_iconv_open_codepages_for_export
+                               (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>,
+                                <em class="parameter"><code><span class="type">char</span> const *from</code></em>);</pre>
+<p>NOTE: skipped since GIConv is not exported to introspection.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.9.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>codepage_to</p></td>
+<td class="parameter_description"><p>the target code page.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>from</p></td>
+<td class="parameter_description"><p>the source encoding.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.9.6"></a><h4>Returns</h4>
+<p> an iconv converter to go from utf8 -&gt; to our best guess at a useful
+windows codepage.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-iconv-open-codepage-for-import"></a><h3>gsf_msole_iconv_open_codepage_for_import ()</h3>
+<pre class="programlisting"><span class="returnvalue">GIConv</span>
+gsf_msole_iconv_open_codepage_for_import
+                               (<em class="parameter"><code><span class="type">char</span> const *to</code></em>,
+                                <em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
+<p>NOTE: skipped since GIConv is not exported to introspection.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.10.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>to</p></td>
+<td class="parameter_description"><p>the target encoding.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>codepage</p></td>
+<td class="parameter_description"><p>the source code page.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.10.6"></a><h4>Returns</h4>
+<p> an iconv converter for <em class="parameter"><code>codepage</code></em>
+-&gt; utf8.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-iconv-open-for-export"></a><h3>gsf_msole_iconv_open_for_export ()</h3>
+<pre class="programlisting"><span class="returnvalue">GIConv</span>
+gsf_msole_iconv_open_for_export (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>NOTE: skipped since GIConv is not exported to introspection.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.11.5"></a><h4>Returns</h4>
+<p> an iconv convert to go from utf8 -&gt; to our best guess at a useful
+windows codepage.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-iconv-open-codepage-for-export"></a><h3>gsf_msole_iconv_open_codepage_for_export ()</h3>
+<pre class="programlisting"><span class="returnvalue">GIConv</span>
+gsf_msole_iconv_open_codepage_for_export
+                               (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>);</pre>
+<p>NOTE: skipped since GIConv is not exported to introspection.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.12.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>codepage_to</p></td>
+<td class="parameter_description"><p>the target code page.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.12.6"></a><h4>Returns</h4>
+<p> an iconv converter to go from utf8 -&gt; to our best guess at a useful
+windows codepage.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-iconv-open-for-import"></a><h3>gsf_msole_iconv_open_for_import ()</h3>
+<pre class="programlisting"><span class="returnvalue">GIConv</span>
+gsf_msole_iconv_open_for_import (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
+<p>NOTE: skipped since GIConv is not exported to introspection.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.13.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>codepage</p></td>
+<td class="parameter_description"><p>the source code page.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.13.6"></a><h4>Returns</h4>
+<p> an iconv converter for single byte encodings <em class="parameter"><code>codepage</code></em>
+-&gt; utf8.
+Attempt to handle the semantics of a specification for multibyte encodings
+since this is only supposed to be used for single bytes.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-iconv-win-codepage"></a><h3>gsf_msole_iconv_win_codepage ()</h3>
+<pre class="programlisting"><span class="returnvalue">int</span>
+gsf_msole_iconv_win_codepage (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.14.4"></a><h4>Returns</h4>
+<p> our best guess at the applicable windows code page based on an
+environment variable or the current locale.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-codepage-to-lid"></a><h3>gsf_msole_codepage_to_lid ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+gsf_msole_codepage_to_lid (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
+<p>
+</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.15.5"></a><h4>Returns</h4>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-lid-to-codepage"></a><h3>gsf_msole_lid_to_codepage ()</h3>
+<pre class="programlisting"><span class="returnvalue">int</span>
+gsf_msole_lid_to_codepage (<em class="parameter"><code><span class="type">guint</span> lid</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.16.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>lid</p></td>
+<td class="parameter_description"><p>numerical language id</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.16.5"></a><h4>Returns</h4>
+<p> our best guess at the codepage for the given language id</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-lid-to-codepage-str"></a><h3>gsf_msole_lid_to_codepage_str ()</h3>
+<pre class="programlisting"><span class="returnvalue">gchar</span> *
+gsf_msole_lid_to_codepage_str (<em class="parameter"><code><span class="type">guint</span> lid</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.17.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>lid</p></td>
+<td class="parameter_description"><p>numerical language id</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.17.5"></a><h4>Returns</h4>
+<p> the Iconv codepage string for the given
+LID. </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-msole-lid-for-language"></a><h3>gsf_msole_lid_for_language ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+gsf_msole_lid_for_language (<em class="parameter"><code><span class="type">char</span> const *lang</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.18.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>lang</p></td>
+<td class="parameter_description"><p> Language id, i.e., locale name. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.18.5"></a><h4>Returns</h4>
+<p> the LID (Language Identifier) for the input language.
+If lang is <code class="literal">NULL</code>, return 0x0400 ("-none-"), and not 0x0000 ("no proofing")</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-language-for-lid"></a><h3>gsf_msole_language_for_lid ()</h3>
+<pre class="programlisting"><span class="returnvalue">char</span> const *
+gsf_msole_language_for_lid (<em class="parameter"><code><span class="type">guint</span> lid</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.19.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>lid</p></td>
+<td class="parameter_description"><p>numerical language id</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.19.5"></a><h4>Returns</h4>
+<p> the xx_YY style string (can be just xx or
+xxx) for the given LID.  If the LID is not found, is set to 0x0400,
+or is set to 0x0000, will return "-none-". </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>
+<hr>
+<div class="refsect2">
+<a name="gsf-msole-inflate"></a><h3>gsf_msole_inflate ()</h3>
+<pre class="programlisting"><span class="returnvalue">GByteArray</span> *
+gsf_msole_inflate (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
+                   <em class="parameter"><code><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> offset</code></em>);</pre>
+<p>Decompresses an LZ compressed stream.</p>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.20.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>input</p></td>
+<td class="parameter_description"><p>stream to read from</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>offset</p></td>
+<td class="parameter_description"><p>offset into it for start byte of compresse stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.6.10.20.6"></a><h4>Returns</h4>
+<p> A GByteArray that the caller is responsible for freeing. </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>
+</div>
+<div class="refsect1">
+<a name="gsf-MS-OLE2.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GsfInfileMSOle-struct"></a><h3>GsfInfileMSOle</h3>
+<pre class="programlisting">typedef struct _GsfInfileMSOle GsfInfileMSOle;</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutfileMSOle-struct"></a><h3>GsfOutfileMSOle</h3>
+<pre class="programlisting">typedef struct _GsfOutfileMSOle GsfOutfileMSOle;</pre>
+<p>
+</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-MS-OLE2.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="GsfOutfileMSOle--big-block-size"></a><h3>The <code class="literal">“big-block-size”</code> property</h3>
+<pre class="programlisting">  “big-block-size”           <span class="type">guint</span></pre>
+<p>The size of the OLE's big blocks.</p>
+<p>Flags: Read / Write / Construct Only</p>
+<p>Allowed values: [128,4096]</p>
+<p>Default value: 512</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutfileMSOle--sink"></a><h3>The <code class="literal">“sink”</code> property</h3>
+<pre class="programlisting">  “sink”                     <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</pre>
+<p>The destination for writes.</p>
+<p>Flags: Read / Write / Construct Only</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfOutfileMSOle--small-block-size"></a><h3>The <code class="literal">“small-block-size”</code> property</h3>
+<pre class="programlisting">  “small-block-size”         <span class="type">guint</span></pre>
+<p>The size of the OLE's small blocks.</p>
+<p>Flags: Read / Write / Construct Only</p>
+<p>Allowed values: [8,4096]</p>
+<p>Default value: 64</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>