doc/html/gsf-MS-OLE2.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>MS OLE2</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="parsers.html" title="Stream Parsers">
   9 <link rel="prev" href="gsf-Compression.html" title="Compression">
  10 <link rel="next" href="gsf-metadata.html" title="metadata">
  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="gsf-Compression.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="parsers.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-metadata.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-MS-OLE2.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gsf-MS-OLE2.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gsf-MS-OLE2.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry" title="MS OLE2">
  32 <a name="gsf-MS-OLE2"></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-MS-OLE2.top_of_page"></a>MS OLE2</span></h2>
  36 <p>MS OLE2</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv" title="Synopsis">
  41 <a name="gsf-MS-OLE2.synopsis"></a><h2>Synopsis</h2>
  42 <a name="GsfInfileMSOle"></a><a name="GsfOutfileMSOle"></a><pre class="synopsis">                    <a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle-struct" title="GsfInfileMSOle">GsfInfileMSOle</a>;
  43 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *         <a class="link" href="gsf-MS-OLE2.html#gsf-infile-msole-new" title="gsf_infile_msole_new ()">gsf_infile_msole_new</a>                (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
  44                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
  45 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>       (<em class="parameter"><code><a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle"><span class="type">GsfInfileMSOle</span></a> const *ole</code></em>,
  46                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *res</code></em>);
  47                     <a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle-struct" title="GsfOutfileMSOle">GsfOutfileMSOle</a>;
  48 <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *        <a class="link" href="gsf-MS-OLE2.html#gsf-outfile-msole-new" title="gsf_outfile_msole_new ()">gsf_outfile_msole_new</a>               (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>);
  49 <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *        <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>          (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
  50                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> bb_size</code></em>,
  51                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> sb_size</code></em>);
  52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>      (<em class="parameter"><code><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle"><span class="type">GsfOutfileMSOle</span></a> *ole</code></em>,
  53                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> const *clsid</code></em>);
  54 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *            <a class="link" href="gsf-MS-OLE2.html#gsf-msole-metadata-read" title="gsf_msole_metadata_read ()">gsf_msole_metadata_read</a>             (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *in</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *accum</code></em>);
  56 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-MS-OLE2.html#gsf-msole-metadata-write" title="gsf_msole_metadata_write ()">gsf_msole_metadata_write</a>            (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *out</code></em>,
  57                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta_data</code></em>,
  58                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> doc_not_component</code></em>);
  59 <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              <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>
  60                                                         (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>,
  61                                                          <em class="parameter"><code><span class="type">char</span> const *from</code></em>);
  62 <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              <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>
  63                                                         (<em class="parameter"><code><span class="type">char</span> const *to</code></em>,
  64                                                          <em class="parameter"><code><span class="type">int</span> codepage</code></em>);
  65 <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              <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>     (<em class="parameter"><code><span class="type">void</span></code></em>);
  66 <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              <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>
  67                                                         (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>);
  68 <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              <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>     (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);
  69 <span class="returnvalue">int</span>                 <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>        (<em class="parameter"><code><span class="type">void</span></code></em>);
  70 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <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>           (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);
  71 <span class="returnvalue">int</span>                 <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>           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> lid</code></em>);
  72 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <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>       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> lid</code></em>);
  73 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <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>          (<em class="parameter"><code><span class="type">char</span> const *lang</code></em>);
  74 <span class="returnvalue">char</span> const *        <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>          (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> lid</code></em>);
  75 <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> *        <a class="link" href="gsf-MS-OLE2.html#gsf-msole-inflate" title="gsf_msole_inflate ()">gsf_msole_inflate</a>                   (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
  76                                                          <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>);
  77 </pre>
  78 </div>
  79 <div class="refsect1" title="Object Hierarchy">
  80 <a name="gsf-MS-OLE2.object-hierarchy"></a><h2>Object Hierarchy</h2>
  81 <pre class="synopsis">
  82   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  83    +----<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
  84          +----<a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
  85                +----GsfInfileMSOle
  86 </pre>
  87 <pre class="synopsis">
  88   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  89    +----<a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
  90          +----<a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
  91                +----GsfOutfileMSOle
  92 </pre>
  93 </div>
  94 <div class="refsect1" title="Description">
  95 <a name="gsf-MS-OLE2.description"></a><h2>Description</h2>
  96 <p>
  97 </p>
  98 </div>
  99 <div class="refsect1" title="Details">
 100 <a name="gsf-MS-OLE2.details"></a><h2>Details</h2>
 101 <div class="refsect2" title="GsfInfileMSOle">
 102 <a name="GsfInfileMSOle-struct"></a><h3>GsfInfileMSOle</h3>
 103 <pre class="programlisting">typedef struct _GsfInfileMSOle GsfInfileMSOle;</pre>
 104 <p>
 105 </p>
 106 </div>
 107 <hr>
 108 <div class="refsect2" title="gsf_infile_msole_new ()">
 109 <a name="gsf-infile-msole-new"></a><h3>gsf_infile_msole_new ()</h3>
 110 <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>,
 111                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
 112 <p>
 113 Opens the root directory of an MS OLE file.
 114 </p>
 115 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 116 <h3 class="title">Note</h3>This adds a reference to <em class="parameter"><code>source</code></em>.</div>
 117 <p>
 118 </p>
 119 <div class="variablelist"><table border="0">
 120 <col align="left" valign="top">
 121 <tbody>
 122 <tr>
 123 <td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 124 <td>
 125 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>
 126 </td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 130 <td>optional place to store an error
 131 </td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 135 <td> the new ole file handler
 136 </td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <hr>
 142 <div class="refsect2" title="gsf_infile_msole_get_class_id ()">
 143 <a name="gsf-infile-msole-get-class-id"></a><h3>gsf_infile_msole_get_class_id ()</h3>
 144 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 145                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> *res</code></em>);</pre>
 146 <p>
 147 Retrieves the 16 byte indentifier (often a GUID in MS Windows apps)
 148 stored within the directory associated with <em class="parameter"><code>ole</code></em> and stores it in <em class="parameter"><code>res</code></em>.
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>ole</code></em> :</span></p></td>
 155 <td>a <a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle"><span class="type">GsfInfileMSOle</span></a>
 156 </td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"><em class="parameter"><code>res</code></em> :</span></p></td>
 160 <td>16 byte identifier (often a GUID in MS Windows apps)
 161 </td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 165 <td> TRUE on success
 166 </td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 <hr>
 172 <div class="refsect2" title="GsfOutfileMSOle">
 173 <a name="GsfOutfileMSOle-struct"></a><h3>GsfOutfileMSOle</h3>
 174 <pre class="programlisting">typedef struct _GsfOutfileMSOle GsfOutfileMSOle;</pre>
 175 <p>
 176 </p>
 177 </div>
 178 <hr>
 179 <div class="refsect2" title="gsf_outfile_msole_new ()">
 180 <a name="gsf-outfile-msole-new"></a><h3>gsf_outfile_msole_new ()</h3>
 181 <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>
 182 <p>
 183 Creates the root directory of an MS OLE file and manages the addition of
 184 children.
 185 </p>
 186 <p>
 187 </p>
 188 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 189 <h3 class="title">Note</h3>This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
 190 <p>
 191 </p>
 192 <div class="variablelist"><table border="0">
 193 <col align="left" valign="top">
 194 <tbody>
 195 <tr>
 196 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 197 <td>a <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the OLE2 file
 198 </td>
 199 </tr>
 200 <tr>
 201 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 202 <td> the new ole file handler.
 203 </td>
 204 </tr>
 205 </tbody>
 206 </table></div>
 207 </div>
 208 <hr>
 209 <div class="refsect2" title="gsf_outfile_msole_new_full ()">
 210 <a name="gsf-outfile-msole-new-full"></a><h3>gsf_outfile_msole_new_full ()</h3>
 211 <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>,
 212                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> bb_size</code></em>,
 213                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> sb_size</code></em>);</pre>
 214 <p>
 215 Creates the root directory of an MS OLE file and manages the addition of
 216 children.
 217 </p>
 218 <p>
 219 </p>
 220 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
 221 <h3 class="title">Note</h3>This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
 222 <p>
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>sink</code></em> :</span></p></td>
 229 <td>a <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the OLE2 file.
 230 </td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><em class="parameter"><code>bb_size</code></em> :</span></p></td>
 234 <td>size of large blocks.
 235 </td>
 236 </tr>
 237 <tr>
 238 <td><p><span class="term"><em class="parameter"><code>sb_size</code></em> :</span></p></td>
 239 <td>size of small blocks.
 240 </td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 244 <td> the new ole file handler.
 245 </td>
 246 </tr>
 247 </tbody>
 248 </table></div>
 249 </div>
 250 <hr>
 251 <div class="refsect2" title="gsf_outfile_msole_set_class_id ()">
 252 <a name="gsf-outfile-msole-set-class-id"></a><h3>gsf_outfile_msole_set_class_id ()</h3>
 253 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 254                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> const *clsid</code></em>);</pre>
 255 <p>
 256 Write <em class="parameter"><code>clsid</code></em> to the directory associated with <em class="parameter"><code>ole</code></em>.
 257 </p>
 258 <div class="variablelist"><table border="0">
 259 <col align="left" valign="top">
 260 <tbody>
 261 <tr>
 262 <td><p><span class="term"><em class="parameter"><code>ole</code></em> :</span></p></td>
 263 <td>a <a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle"><span class="type">GsfOutfileMSOle</span></a>
 264 </td>
 265 </tr>
 266 <tr>
 267 <td><p><span class="term"><em class="parameter"><code>clsid</code></em> :</span></p></td>
 268 <td>16 byte identifier (often a GUID in MS Windows apps)
 269 </td>
 270 </tr>
 271 <tr>
 272 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 273 <td> TRUE on success.
 274 </td>
 275 </tr>
 276 </tbody>
 277 </table></div>
 278 </div>
 279 <hr>
 280 <div class="refsect2" title="gsf_msole_metadata_read ()">
 281 <a name="gsf-msole-metadata-read"></a><h3>gsf_msole_metadata_read ()</h3>
 282 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *            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>,
 283                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *accum</code></em>);</pre>
 284 <p>
 285 Read a stream formated as a set of MS OLE properties from <em class="parameter"><code>in</code></em> and store the
 286 results in <em class="parameter"><code>accum</code></em>.
 287 </p>
 288 <div class="variablelist"><table border="0">
 289 <col align="left" valign="top">
 290 <tbody>
 291 <tr>
 292 <td><p><span class="term"><em class="parameter"><code>in</code></em> :</span></p></td>
 293 <td>
 294 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>
 295 </td>
 296 </tr>
 297 <tr>
 298 <td><p><span class="term"><em class="parameter"><code>accum</code></em> :</span></p></td>
 299 <td>
 300 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
 301 </td>
 302 </tr>
 303 <tr>
 304 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 305 <td> GError which the caller must free on error.
 306 </td>
 307 </tr>
 308 </tbody>
 309 </table></div>
 310 </div>
 311 <hr>
 312 <div class="refsect2" title="gsf_msole_metadata_write ()">
 313 <a name="gsf-msole-metadata-write"></a><h3>gsf_msole_metadata_write ()</h3>
 314 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 315                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta_data</code></em>,
 316                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> doc_not_component</code></em>);</pre>
 317 <div class="variablelist"><table border="0">
 318 <col align="left" valign="top">
 319 <tbody>
 320 <tr>
 321 <td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td>
 322 <td>
 323 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
 324 </td>
 325 </tr>
 326 <tr>
 327 <td><p><span class="term"><em class="parameter"><code>meta_data</code></em> :</span></p></td>
 328 <td>
 329 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
 330 </td>
 331 </tr>
 332 <tr>
 333 <td><p><span class="term"><em class="parameter"><code>doc_not_component</code></em> :</span></p></td>
 334 <td>a kludge to differentiate DocumentSummary from Summary
 335 </td>
 336 </tr>
 337 <tr>
 338 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 339 <td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success;
 340 </td>
 341 </tr>
 342 </tbody>
 343 </table></div>
 344 </div>
 345 <hr>
 346 <div class="refsect2" title="gsf_msole_iconv_open_codepages_for_export ()">
 347 <a name="gsf-msole-iconv-open-codepages-for-export"></a><h3>gsf_msole_iconv_open_codepages_for_export ()</h3>
 348 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              gsf_msole_iconv_open_codepages_for_export
 349                                                         (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>,
 350                                                          <em class="parameter"><code><span class="type">char</span> const *from</code></em>);</pre>
 351 <div class="variablelist"><table border="0">
 352 <col align="left" valign="top">
 353 <tbody><tr>
 354 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 355 <td> an iconv converter to go from utf8 -&gt; to our best guess at a useful
 356         windows codepage.
 357 </td>
 358 </tr></tbody>
 359 </table></div>
 360 </div>
 361 <hr>
 362 <div class="refsect2" title="gsf_msole_iconv_open_codepage_for_import ()">
 363 <a name="gsf-msole-iconv-open-codepage-for-import"></a><h3>gsf_msole_iconv_open_codepage_for_import ()</h3>
 364 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              gsf_msole_iconv_open_codepage_for_import
 365                                                         (<em class="parameter"><code><span class="type">char</span> const *to</code></em>,
 366                                                          <em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
 367 <div class="variablelist"><table border="0">
 368 <col align="left" valign="top">
 369 <tbody><tr>
 370 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 371 <td> an iconv converter for <em class="parameter"><code>codepage</code></em> -&gt; utf8.
 372 </td>
 373 </tr></tbody>
 374 </table></div>
 375 </div>
 376 <hr>
 377 <div class="refsect2" title="gsf_msole_iconv_open_for_export ()">
 378 <a name="gsf-msole-iconv-open-for-export"></a><h3>gsf_msole_iconv_open_for_export ()</h3>
 379 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              gsf_msole_iconv_open_for_export     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 380 <div class="variablelist"><table border="0">
 381 <col align="left" valign="top">
 382 <tbody><tr>
 383 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 384 <td> an iconv convert to go from utf8 -&gt; to our best guess at a useful
 385         windows codepage.
 386 </td>
 387 </tr></tbody>
 388 </table></div>
 389 </div>
 390 <hr>
 391 <div class="refsect2" title="gsf_msole_iconv_open_codepage_for_export ()">
 392 <a name="gsf-msole-iconv-open-codepage-for-export"></a><h3>gsf_msole_iconv_open_codepage_for_export ()</h3>
 393 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              gsf_msole_iconv_open_codepage_for_export
 394                                                         (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>);</pre>
 395 <div class="variablelist"><table border="0">
 396 <col align="left" valign="top">
 397 <tbody><tr>
 398 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 399 <td> an iconv converter to go from utf8 -&gt; to our best guess at a useful
 400         windows codepage.
 401 </td>
 402 </tr></tbody>
 403 </table></div>
 404 </div>
 405 <hr>
 406 <div class="refsect2" title="gsf_msole_iconv_open_for_import ()">
 407 <a name="gsf-msole-iconv-open-for-import"></a><h3>gsf_msole_iconv_open_for_import ()</h3>
 408 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#GIConv"><span class="returnvalue">GIConv</span></a>              gsf_msole_iconv_open_for_import     (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
 409 <div class="variablelist"><table border="0">
 410 <col align="left" valign="top">
 411 <tbody><tr>
 412 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 413 <td> an iconv converter for single byte encodings <em class="parameter"><code>codepage</code></em> -&gt; utf8.
 414         Attempt to handle the semantics of a specification for multibyte encodings
 415         since this is only supposed to be used for single bytes.
 416 </td>
 417 </tr></tbody>
 418 </table></div>
 419 </div>
 420 <hr>
 421 <div class="refsect2" title="gsf_msole_iconv_win_codepage ()">
 422 <a name="gsf-msole-iconv-win-codepage"></a><h3>gsf_msole_iconv_win_codepage ()</h3>
 423 <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>
 424 <div class="variablelist"><table border="0">
 425 <col align="left" valign="top">
 426 <tbody><tr>
 427 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 428 <td> our best guess at the applicable windows code page based on an
 429         environment variable or the current locale.
 430 </td>
 431 </tr></tbody>
 432 </table></div>
 433 </div>
 434 <hr>
 435 <div class="refsect2" title="gsf_msole_codepage_to_lid ()">
 436 <a name="gsf-msole-codepage-to-lid"></a><h3>gsf_msole_codepage_to_lid ()</h3>
 437 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gsf_msole_codepage_to_lid           (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
 438 <p>
 439 </p>
 440 <div class="variablelist"><table border="0">
 441 <col align="left" valign="top">
 442 <tbody>
 443 <tr>
 444 <td><p><span class="term"><em class="parameter"><code>codepage</code></em> :</span></p></td>
 445 <td>
 446 </td>
 447 </tr>
 448 <tr>
 449 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 450 <td>
 451 </td>
 452 </tr>
 453 </tbody>
 454 </table></div>
 455 </div>
 456 <hr>
 457 <div class="refsect2" title="gsf_msole_lid_to_codepage ()">
 458 <a name="gsf-msole-lid-to-codepage"></a><h3>gsf_msole_lid_to_codepage ()</h3>
 459 <pre class="programlisting"><span class="returnvalue">int</span>                 gsf_msole_lid_to_codepage           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> lid</code></em>);</pre>
 460 <div class="variablelist"><table border="0">
 461 <col align="left" valign="top">
 462 <tbody><tr>
 463 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 464 <td> our best guess at the codepage for the given language id
 465 </td>
 466 </tr></tbody>
 467 </table></div>
 468 </div>
 469 <hr>
 470 <div class="refsect2" title="gsf_msole_lid_to_codepage_str ()">
 471 <a name="gsf-msole-lid-to-codepage-str"></a><h3>gsf_msole_lid_to_codepage_str ()</h3>
 472 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gsf_msole_lid_to_codepage_str       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> lid</code></em>);</pre>
 473 <div class="variablelist"><table border="0">
 474 <col align="left" valign="top">
 475 <tbody><tr>
 476 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 477 <td> the Iconv codepage string for the given LID.
 478         Return value must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>'d
 479 </td>
 480 </tr></tbody>
 481 </table></div>
 482 </div>
 483 <hr>
 484 <div class="refsect2" title="gsf_msole_lid_for_language ()">
 485 <a name="gsf-msole-lid-for-language"></a><h3>gsf_msole_lid_for_language ()</h3>
 486 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gsf_msole_lid_for_language          (<em class="parameter"><code><span class="type">char</span> const *lang</code></em>);</pre>
 487 <div class="variablelist"><table border="0">
 488 <col align="left" valign="top">
 489 <tbody><tr>
 490 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 491 <td> the LID (Language Identifier) for the input language.
 492         If lang is <code class="literal">null</code>, return 0x0400 ("-none-"), and not 0x0000 ("no proofing")
 493 </td>
 494 </tr></tbody>
 495 </table></div>
 496 </div>
 497 <hr>
 498 <div class="refsect2" title="gsf_msole_language_for_lid ()">
 499 <a name="gsf-msole-language-for-lid"></a><h3>gsf_msole_language_for_lid ()</h3>
 500 <pre class="programlisting"><span class="returnvalue">char</span> const *        gsf_msole_language_for_lid          (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> lid</code></em>);</pre>
 501 <div class="variablelist"><table border="0">
 502 <col align="left" valign="top">
 503 <tbody><tr>
 504 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 505 <td> the xx_YY style string (can be just xx or xxx) for the given LID.
 506         Return value must not be freed. If the LID is not found, is set to
 507         0x0400, or is set to 0x0000, will return "-none-"
 508 </td>
 509 </tr></tbody>
 510 </table></div>
 511 </div>
 512 <hr>
 513 <div class="refsect2" title="gsf_msole_inflate ()">
 514 <a name="gsf-msole-inflate"></a><h3>gsf_msole_inflate ()</h3>
 515 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GByteArray"><span class="returnvalue">GByteArray</span></a> *        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>,
 516                                                          <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>
 517 <p>
 518 Decompresses an LZ compressed stream.
 519 </p>
 520 <div class="variablelist"><table border="0">
 521 <col align="left" valign="top">
 522 <tbody>
 523 <tr>
 524 <td><p><span class="term"><em class="parameter"><code>input</code></em> :</span></p></td>
 525 <td>stream to read from
 526 </td>
 527 </tr>
 528 <tr>
 529 <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
 530 <td>offset into it for start byte of compresse stream
 531 </td>
 532 </tr>
 533 <tr>
 534 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 535 <td> A GByteArray that the caller is responsible for freeing
 536 </td>
 537 </tr>
 538 </tbody>
 539 </table></div>
 540 </div>
 541 </div>
 542 </div>
 543 <div class="footer">
 544 <hr>
 545           Generated by GTK-Doc V1.14</div>
 546 </body>
 547 </html>