Debian Codegraph @

doc/html/gsf-MS-OLE2.html

raw
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: GSF Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
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.34.0 (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="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gsf-MS-OLE2.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#gsf-MS-OLE2.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
20 <a href="#gsf-MS-OLE2.properties" class="shortcut">Properties</a></span>
21 </td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23 <td><a accesskey="u" href="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="gsf-Compression.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="gsf-metadata.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 </tr></table>
27 <div class="refentry">
28 <a name="gsf-MS-OLE2"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="gsf-MS-OLE2.top_of_page"></a>MS OLE2</span></h2>
32 <p>MS OLE2</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="gsf-MS-OLE2.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_proto_type">
41 <col class="functions_proto_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *
47 </td>
48 <td class="function_name">
49 <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>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <span class="returnvalue">gboolean</span>
55 </td>
56 <td class="function_name">
57 <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>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
63 </td>
64 <td class="function_name">
65 <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>
66 </td>
67 </tr>
68 <tr>
69 <td class="function_type">
70 <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
71 </td>
72 <td class="function_name">
73 <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>
74 </td>
75 </tr>
76 <tr>
77 <td class="function_type">
78 <span class="returnvalue">gboolean</span>
79 </td>
80 <td class="function_name">
81 <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>
82 </td>
83 </tr>
84 <tr>
85 <td class="function_type">
86 <span class="returnvalue">GError</span> *
87 </td>
88 <td class="function_name">
89 <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>
90 </td>
91 </tr>
92 <tr>
93 <td class="function_type">
94 <span class="returnvalue">gboolean</span>
95 </td>
96 <td class="function_name">
97 <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>
98 </td>
99 </tr>
100 <tr>
101 <td class="function_type">
102 <span class="returnvalue">GIConv</span>
103 </td>
104 <td class="function_name">
105 <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>
106 </td>
107 </tr>
108 <tr>
109 <td class="function_type">
110 <span class="returnvalue">GIConv</span>
111 </td>
112 <td class="function_name">
113 <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>
114 </td>
115 </tr>
116 <tr>
117 <td class="function_type">
118 <span class="returnvalue">GIConv</span>
119 </td>
120 <td class="function_name">
121 <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>
122 </td>
123 </tr>
124 <tr>
125 <td class="function_type">
126 <span class="returnvalue">GIConv</span>
127 </td>
128 <td class="function_name">
129 <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>
130 </td>
131 </tr>
132 <tr>
133 <td class="function_type">
134 <span class="returnvalue">GIConv</span>
135 </td>
136 <td class="function_name">
137 <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>
138 </td>
139 </tr>
140 <tr>
141 <td class="function_type">
142 <span class="returnvalue">int</span>
143 </td>
144 <td class="function_name">
145 <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>
146 </td>
147 </tr>
148 <tr>
149 <td class="function_type">
150 <span class="returnvalue">guint</span>
151 </td>
152 <td class="function_name">
153 <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>
154 </td>
155 </tr>
156 <tr>
157 <td class="function_type">
158 <span class="returnvalue">int</span>
159 </td>
160 <td class="function_name">
161 <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>
162 </td>
163 </tr>
164 <tr>
165 <td class="function_type">
166 <span class="returnvalue">gchar</span> *
167 </td>
168 <td class="function_name">
169 <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>
170 </td>
171 </tr>
172 <tr>
173 <td class="function_type">
174 <span class="returnvalue">guint</span>
175 </td>
176 <td class="function_name">
177 <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>
178 </td>
179 </tr>
180 <tr>
181 <td class="function_type">
182 <span class="returnvalue">char</span> const *
183 </td>
184 <td class="function_name">
185 <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>
186 </td>
187 </tr>
188 <tr>
189 <td class="function_type">
190 <span class="returnvalue">GByteArray</span> *
191 </td>
192 <td class="function_name">
193 <a class="link" href="gsf-MS-OLE2.html#gsf-msole-inflate" title="gsf_msole_inflate ()">gsf_msole_inflate</a> <span class="c_punctuation">()</span>
194 </td>
195 </tr>
196 </tbody>
197 </table></div>
198 </div>
199 <div class="refsect1">
200 <a name="gsf-MS-OLE2.properties"></a><h2>Properties</h2>
201 <div class="informaltable"><table class="informaltable" border="0">
202 <colgroup>
203 <col width="150px" class="properties_type">
204 <col width="300px" class="properties_name">
205 <col width="200px" class="properties_flags">
206 </colgroup>
207 <tbody>
208 <tr>
209 <td class="property_type"><span class="type">guint</span></td>
210 <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>
211 <td class="property_flags">Read / Write / Construct Only</td>
212 </tr>
213 <tr>
214 <td class="property_type">
215 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</td>
216 <td class="property_name"><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle--sink" title="The “sink” property">sink</a></td>
217 <td class="property_flags">Read / Write / Construct Only</td>
218 </tr>
219 <tr>
220 <td class="property_type"><span class="type">guint</span></td>
221 <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>
222 <td class="property_flags">Read / Write / Construct Only</td>
223 </tr>
224 </tbody>
225 </table></div>
226 </div>
227 <a name="GsfInfileMSOle"></a><a name="GsfOutfileMSOle"></a><div class="refsect1">
228 <a name="gsf-MS-OLE2.other"></a><h2>Types and Values</h2>
229 <div class="informaltable"><table class="informaltable" width="100%" border="0">
230 <colgroup>
231 <col width="150px" class="other_proto_type">
232 <col class="other_proto_name">
233 </colgroup>
234 <tbody>
235 <tr>
236 <td class="datatype_keyword"> </td>
237 <td class="function_name"><a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle-struct" title="GsfInfileMSOle">GsfInfileMSOle</a></td>
238 </tr>
239 <tr>
240 <td class="datatype_keyword"> </td>
241 <td class="function_name"><a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle-struct" title="GsfOutfileMSOle">GsfOutfileMSOle</a></td>
242 </tr>
243 </tbody>
244 </table></div>
245 </div>
246 <div class="refsect1">
247 <a name="gsf-MS-OLE2.object-hierarchy"></a><h2>Object Hierarchy</h2>
248 <pre class="screen"> GObject
249 <span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
250 <span class="lineart">│</span> <span class="lineart">╰──</span> <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
251 <span class="lineart">│</span> <span class="lineart">╰──</span> GsfInfileMSOle
252 <span class="lineart">╰──</span> <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
253 <span class="lineart">╰──</span> <a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
254 <span class="lineart">╰──</span> GsfOutfileMSOle
255 </pre>
256 </div>
257 <div class="refsect1">
258 <a name="gsf-MS-OLE2.description"></a><h2>Description</h2>
259 </div>
260 <div class="refsect1">
261 <a name="gsf-MS-OLE2.functions_details"></a><h2>Functions</h2>
262 <div class="refsect2">
263 <a name="gsf-infile-msole-new"></a><h3>gsf_infile_msole_new ()</h3>
264 <pre class="programlisting"><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *
265 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>,
266 <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
267 <p>Opens the root directory of an MS OLE file.</p>
268 <div class="note">This adds a reference to <em class="parameter"><code>source</code></em>.</div>
269 <div class="refsect3">
270 <a name="gsf-infile-msole-new.parameters"></a><h4>Parameters</h4>
271 <div class="informaltable"><table class="informaltable" width="100%" border="0">
272 <colgroup>
273 <col width="150px" class="parameters_name">
274 <col class="parameters_description">
275 <col width="200px" class="parameters_annotations">
276 </colgroup>
277 <tbody>
278 <tr>
279 <td class="parameter_name"><p>source</p></td>
280 <td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
281 <td class="parameter_annotations"> </td>
282 </tr>
283 <tr>
284 <td class="parameter_name"><p>err</p></td>
285 <td class="parameter_description"><p>optional place to store an error</p></td>
286 <td class="parameter_annotations"> </td>
287 </tr>
288 </tbody>
289 </table></div>
290 </div>
291 <div class="refsect3">
292 <a name="gsf-infile-msole-new.returns"></a><h4>Returns</h4>
293 <p> the new ole file handler</p>
294 </div>
295 </div>
296 <hr>
297 <div class="refsect2">
298 <a name="gsf-infile-msole-get-class-id"></a><h3>gsf_infile_msole_get_class_id ()</h3>
299 <pre class="programlisting"><span class="returnvalue">gboolean</span>
300 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>,
301 <em class="parameter"><code><span class="type">guint8</span> *res</code></em>);</pre>
302 <p>Retrieves the 16 byte indentifier (often a GUID in MS Windows apps)
303 stored within the directory associated with <em class="parameter"><code>ole</code></em>
304 and stores it in <em class="parameter"><code>res</code></em>
305 .</p>
306 <div class="refsect3">
307 <a name="gsf-infile-msole-get-class-id.parameters"></a><h4>Parameters</h4>
308 <div class="informaltable"><table class="informaltable" width="100%" border="0">
309 <colgroup>
310 <col width="150px" class="parameters_name">
311 <col class="parameters_description">
312 <col width="200px" class="parameters_annotations">
313 </colgroup>
314 <tbody>
315 <tr>
316 <td class="parameter_name"><p>ole</p></td>
317 <td class="parameter_description"><p>a <a class="link" href="gsf-MS-OLE2.html#GsfInfileMSOle"><span class="type">GsfInfileMSOle</span></a></p></td>
318 <td class="parameter_annotations"> </td>
319 </tr>
320 <tr>
321 <td class="parameter_name"><p>res</p></td>
322 <td class="parameter_description"><p>16 byte identifier (often a GUID in MS Windows apps)</p></td>
323 <td class="parameter_annotations"> </td>
324 </tr>
325 </tbody>
326 </table></div>
327 </div>
328 <div class="refsect3">
329 <a name="gsf-infile-msole-get-class-id.returns"></a><h4>Returns</h4>
330 <p> TRUE on success</p>
331 </div>
332 </div>
333 <hr>
334 <div class="refsect2">
335 <a name="gsf-outfile-msole-new"></a><h3>gsf_outfile_msole_new ()</h3>
336 <pre class="programlisting"><a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
337 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>
338 <p>Creates the root directory of an MS OLE file and manages the addition of
339 children.</p>
340 <div class="note">This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
341 <div class="refsect3">
342 <a name="gsf-outfile-msole-new.parameters"></a><h4>Parameters</h4>
343 <div class="informaltable"><table class="informaltable" width="100%" border="0">
344 <colgroup>
345 <col width="150px" class="parameters_name">
346 <col class="parameters_description">
347 <col width="200px" class="parameters_annotations">
348 </colgroup>
349 <tbody><tr>
350 <td class="parameter_name"><p>sink</p></td>
351 <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>
352 <td class="parameter_annotations"> </td>
353 </tr></tbody>
354 </table></div>
355 </div>
356 <div class="refsect3">
357 <a name="gsf-outfile-msole-new.returns"></a><h4>Returns</h4>
358 <p> the new ole file handler.</p>
359 </div>
360 </div>
361 <hr>
362 <div class="refsect2">
363 <a name="gsf-outfile-msole-new-full"></a><h3>gsf_outfile_msole_new_full ()</h3>
364 <pre class="programlisting"><a class="link" href="gsf-Outfile-writing-structed-files.html#GsfOutfile"><span class="returnvalue">GsfOutfile</span></a> *
365 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>,
366 <em class="parameter"><code><span class="type">guint</span> bb_size</code></em>,
367 <em class="parameter"><code><span class="type">guint</span> sb_size</code></em>);</pre>
368 <p>Creates the root directory of an MS OLE file and manages the addition of
369 children.</p>
370 <div class="note">This adds a reference to <em class="parameter"><code>sink</code></em>.</div>
371 <div class="refsect3">
372 <a name="gsf-outfile-msole-new-full.parameters"></a><h4>Parameters</h4>
373 <div class="informaltable"><table class="informaltable" width="100%" border="0">
374 <colgroup>
375 <col width="150px" class="parameters_name">
376 <col class="parameters_description">
377 <col width="200px" class="parameters_annotations">
378 </colgroup>
379 <tbody>
380 <tr>
381 <td class="parameter_name"><p>sink</p></td>
382 <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>
383 <td class="parameter_annotations"> </td>
384 </tr>
385 <tr>
386 <td class="parameter_name"><p>bb_size</p></td>
387 <td class="parameter_description"><p>size of large blocks.</p></td>
388 <td class="parameter_annotations"> </td>
389 </tr>
390 <tr>
391 <td class="parameter_name"><p>sb_size</p></td>
392 <td class="parameter_description"><p>size of small blocks.</p></td>
393 <td class="parameter_annotations"> </td>
394 </tr>
395 </tbody>
396 </table></div>
397 </div>
398 <div class="refsect3">
399 <a name="gsf-outfile-msole-new-full.returns"></a><h4>Returns</h4>
400 <p> the new ole file handler.</p>
401 </div>
402 </div>
403 <hr>
404 <div class="refsect2">
405 <a name="gsf-outfile-msole-set-class-id"></a><h3>gsf_outfile_msole_set_class_id ()</h3>
406 <pre class="programlisting"><span class="returnvalue">gboolean</span>
407 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>,
408 <em class="parameter"><code><span class="type">guint8</span> const *clsid</code></em>);</pre>
409 <p>Write <em class="parameter"><code>clsid</code></em>
410 to the directory associated with <em class="parameter"><code>ole</code></em>
411 .</p>
412 <div class="refsect3">
413 <a name="gsf-outfile-msole-set-class-id.parameters"></a><h4>Parameters</h4>
414 <div class="informaltable"><table class="informaltable" width="100%" border="0">
415 <colgroup>
416 <col width="150px" class="parameters_name">
417 <col class="parameters_description">
418 <col width="200px" class="parameters_annotations">
419 </colgroup>
420 <tbody>
421 <tr>
422 <td class="parameter_name"><p>ole</p></td>
423 <td class="parameter_description"><p>a <a class="link" href="gsf-MS-OLE2.html#GsfOutfileMSOle"><span class="type">GsfOutfileMSOle</span></a></p></td>
424 <td class="parameter_annotations"> </td>
425 </tr>
426 <tr>
427 <td class="parameter_name"><p>clsid</p></td>
428 <td class="parameter_description"><p>Identifier (often a GUID in MS Windows apps). </p></td>
429 <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>
430 </tr>
431 </tbody>
432 </table></div>
433 </div>
434 <div class="refsect3">
435 <a name="gsf-outfile-msole-set-class-id.returns"></a><h4>Returns</h4>
436 <p> <code class="literal">TRUE</code> on success.</p>
437 </div>
438 </div>
439 <hr>
440 <div class="refsect2">
441 <a name="gsf-msole-metadata-read"></a><h3>gsf_msole_metadata_read ()</h3>
442 <pre class="programlisting"><span class="returnvalue">GError</span> *
443 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>,
444 <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *accum</code></em>);</pre>
445 <div class="warning">
446 <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>
447 <p>, use gsf_doc_meta_data_read_from_msole</p>
448 </div>
449 <p>Read a stream formated as a set of MS OLE properties from <em class="parameter"><code>in</code></em>
450 and store the
451 results in <em class="parameter"><code>accum</code></em>
452 .</p>
453 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
454 <div class="refsect3">
455 <a name="gsf-msole-metadata-read.parameters"></a><h4>Parameters</h4>
456 <div class="informaltable"><table class="informaltable" width="100%" border="0">
457 <colgroup>
458 <col width="150px" class="parameters_name">
459 <col class="parameters_description">
460 <col width="200px" class="parameters_annotations">
461 </colgroup>
462 <tbody>
463 <tr>
464 <td class="parameter_name"><p>in</p></td>
465 <td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
466 <td class="parameter_annotations"> </td>
467 </tr>
468 <tr>
469 <td class="parameter_name"><p>accum</p></td>
470 <td class="parameter_description"><p><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a></p></td>
471 <td class="parameter_annotations"> </td>
472 </tr>
473 </tbody>
474 </table></div>
475 </div>
476 <div class="refsect3">
477 <a name="gsf-msole-metadata-read.returns"></a><h4>Returns</h4>
478 <p>A <span class="type">GError</span> if there was an error. </p>
479 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
480 </div>
481 </div>
482 <hr>
483 <div class="refsect2">
484 <a name="gsf-msole-metadata-write"></a><h3>gsf_msole_metadata_write ()</h3>
485 <pre class="programlisting"><span class="returnvalue">gboolean</span>
486 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>,
487 <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *meta_data</code></em>,
488 <em class="parameter"><code><span class="type">gboolean</span> doc_not_component</code></em>);</pre>
489 <div class="warning">
490 <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>
491 <p>, use gsf_doc_meta_data_write_to_msole</p>
492 </div>
493 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
494 <div class="refsect3">
495 <a name="gsf-msole-metadata-write.parameters"></a><h4>Parameters</h4>
496 <div class="informaltable"><table class="informaltable" width="100%" border="0">
497 <colgroup>
498 <col width="150px" class="parameters_name">
499 <col class="parameters_description">
500 <col width="200px" class="parameters_annotations">
501 </colgroup>
502 <tbody>
503 <tr>
504 <td class="parameter_name"><p>out</p></td>
505 <td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
506 <td class="parameter_annotations"> </td>
507 </tr>
508 <tr>
509 <td class="parameter_name"><p>meta_data</p></td>
510 <td class="parameter_description"><p><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a></p></td>
511 <td class="parameter_annotations"> </td>
512 </tr>
513 <tr>
514 <td class="parameter_name"><p>doc_not_component</p></td>
515 <td class="parameter_description"><p>a kludge to differentiate DocumentSummary from Summary</p></td>
516 <td class="parameter_annotations"> </td>
517 </tr>
518 </tbody>
519 </table></div>
520 </div>
521 <div class="refsect3">
522 <a name="gsf-msole-metadata-write.returns"></a><h4>Returns</h4>
523 <p> <code class="literal">TRUE</code> on success;</p>
524 </div>
525 </div>
526 <hr>
527 <div class="refsect2">
528 <a name="gsf-msole-iconv-open-codepages-for-export"></a><h3>gsf_msole_iconv_open_codepages_for_export ()</h3>
529 <pre class="programlisting"><span class="returnvalue">GIConv</span>
530 gsf_msole_iconv_open_codepages_for_export
531 (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>,
532 <em class="parameter"><code><span class="type">char</span> const *from</code></em>);</pre>
533 <p>NOTE: skipped since GIConv is not exported to introspection.</p>
534 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
535 <div class="refsect3">
536 <a name="gsf-msole-iconv-open-codepages-for-export.parameters"></a><h4>Parameters</h4>
537 <div class="informaltable"><table class="informaltable" width="100%" border="0">
538 <colgroup>
539 <col width="150px" class="parameters_name">
540 <col class="parameters_description">
541 <col width="200px" class="parameters_annotations">
542 </colgroup>
543 <tbody>
544 <tr>
545 <td class="parameter_name"><p>codepage_to</p></td>
546 <td class="parameter_description"><p>the target code page.</p></td>
547 <td class="parameter_annotations"> </td>
548 </tr>
549 <tr>
550 <td class="parameter_name"><p>from</p></td>
551 <td class="parameter_description"><p>the source encoding.</p></td>
552 <td class="parameter_annotations"> </td>
553 </tr>
554 </tbody>
555 </table></div>
556 </div>
557 <div class="refsect3">
558 <a name="gsf-msole-iconv-open-codepages-for-export.returns"></a><h4>Returns</h4>
559 <p> an iconv converter to go from utf8 -&gt; to our best guess at a useful
560 windows codepage.</p>
561 </div>
562 </div>
563 <hr>
564 <div class="refsect2">
565 <a name="gsf-msole-iconv-open-codepage-for-import"></a><h3>gsf_msole_iconv_open_codepage_for_import ()</h3>
566 <pre class="programlisting"><span class="returnvalue">GIConv</span>
567 gsf_msole_iconv_open_codepage_for_import
568 (<em class="parameter"><code><span class="type">char</span> const *to</code></em>,
569 <em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
570 <p>NOTE: skipped since GIConv is not exported to introspection.</p>
571 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
572 <div class="refsect3">
573 <a name="gsf-msole-iconv-open-codepage-for-import.parameters"></a><h4>Parameters</h4>
574 <div class="informaltable"><table class="informaltable" width="100%" border="0">
575 <colgroup>
576 <col width="150px" class="parameters_name">
577 <col class="parameters_description">
578 <col width="200px" class="parameters_annotations">
579 </colgroup>
580 <tbody>
581 <tr>
582 <td class="parameter_name"><p>to</p></td>
583 <td class="parameter_description"><p>the target encoding.</p></td>
584 <td class="parameter_annotations"> </td>
585 </tr>
586 <tr>
587 <td class="parameter_name"><p>codepage</p></td>
588 <td class="parameter_description"><p>the source code page.</p></td>
589 <td class="parameter_annotations"> </td>
590 </tr>
591 </tbody>
592 </table></div>
593 </div>
594 <div class="refsect3">
595 <a name="gsf-msole-iconv-open-codepage-for-import.returns"></a><h4>Returns</h4>
596 <p> an iconv converter for <em class="parameter"><code>codepage</code></em>
597 -&gt; utf8.</p>
598 </div>
599 </div>
600 <hr>
601 <div class="refsect2">
602 <a name="gsf-msole-iconv-open-for-export"></a><h3>gsf_msole_iconv_open_for_export ()</h3>
603 <pre class="programlisting"><span class="returnvalue">GIConv</span>
604 gsf_msole_iconv_open_for_export (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
605 <p>NOTE: skipped since GIConv is not exported to introspection.</p>
606 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
607 <div class="refsect3">
608 <a name="gsf-msole-iconv-open-for-export.returns"></a><h4>Returns</h4>
609 <p> an iconv convert to go from utf8 -&gt; to our best guess at a useful
610 windows codepage.</p>
611 </div>
612 </div>
613 <hr>
614 <div class="refsect2">
615 <a name="gsf-msole-iconv-open-codepage-for-export"></a><h3>gsf_msole_iconv_open_codepage_for_export ()</h3>
616 <pre class="programlisting"><span class="returnvalue">GIConv</span>
617 gsf_msole_iconv_open_codepage_for_export
618 (<em class="parameter"><code><span class="type">int</span> codepage_to</code></em>);</pre>
619 <p>NOTE: skipped since GIConv is not exported to introspection.</p>
620 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
621 <div class="refsect3">
622 <a name="gsf-msole-iconv-open-codepage-for-export.parameters"></a><h4>Parameters</h4>
623 <div class="informaltable"><table class="informaltable" width="100%" border="0">
624 <colgroup>
625 <col width="150px" class="parameters_name">
626 <col class="parameters_description">
627 <col width="200px" class="parameters_annotations">
628 </colgroup>
629 <tbody><tr>
630 <td class="parameter_name"><p>codepage_to</p></td>
631 <td class="parameter_description"><p>the target code page.</p></td>
632 <td class="parameter_annotations"> </td>
633 </tr></tbody>
634 </table></div>
635 </div>
636 <div class="refsect3">
637 <a name="gsf-msole-iconv-open-codepage-for-export.returns"></a><h4>Returns</h4>
638 <p> an iconv converter to go from utf8 -&gt; to our best guess at a useful
639 windows codepage.</p>
640 </div>
641 </div>
642 <hr>
643 <div class="refsect2">
644 <a name="gsf-msole-iconv-open-for-import"></a><h3>gsf_msole_iconv_open_for_import ()</h3>
645 <pre class="programlisting"><span class="returnvalue">GIConv</span>
646 gsf_msole_iconv_open_for_import (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
647 <p>NOTE: skipped since GIConv is not exported to introspection.</p>
648 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
649 <div class="refsect3">
650 <a name="gsf-msole-iconv-open-for-import.parameters"></a><h4>Parameters</h4>
651 <div class="informaltable"><table class="informaltable" width="100%" border="0">
652 <colgroup>
653 <col width="150px" class="parameters_name">
654 <col class="parameters_description">
655 <col width="200px" class="parameters_annotations">
656 </colgroup>
657 <tbody><tr>
658 <td class="parameter_name"><p>codepage</p></td>
659 <td class="parameter_description"><p>the source code page.</p></td>
660 <td class="parameter_annotations"> </td>
661 </tr></tbody>
662 </table></div>
663 </div>
664 <div class="refsect3">
665 <a name="gsf-msole-iconv-open-for-import.returns"></a><h4>Returns</h4>
666 <p> an iconv converter for single byte encodings <em class="parameter"><code>codepage</code></em>
667 -&gt; utf8.
668 Attempt to handle the semantics of a specification for multibyte encodings
669 since this is only supposed to be used for single bytes.</p>
670 </div>
671 </div>
672 <hr>
673 <div class="refsect2">
674 <a name="gsf-msole-iconv-win-codepage"></a><h3>gsf_msole_iconv_win_codepage ()</h3>
675 <pre class="programlisting"><span class="returnvalue">int</span>
676 gsf_msole_iconv_win_codepage (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
677 <div class="refsect3">
678 <a name="gsf-msole-iconv-win-codepage.returns"></a><h4>Returns</h4>
679 <p> our best guess at the applicable windows code page based on an
680 environment variable or the current locale.</p>
681 </div>
682 </div>
683 <hr>
684 <div class="refsect2">
685 <a name="gsf-msole-codepage-to-lid"></a><h3>gsf_msole_codepage_to_lid ()</h3>
686 <pre class="programlisting"><span class="returnvalue">guint</span>
687 gsf_msole_codepage_to_lid (<em class="parameter"><code><span class="type">int</span> codepage</code></em>);</pre>
688 </div>
689 <hr>
690 <div class="refsect2">
691 <a name="gsf-msole-lid-to-codepage"></a><h3>gsf_msole_lid_to_codepage ()</h3>
692 <pre class="programlisting"><span class="returnvalue">int</span>
693 gsf_msole_lid_to_codepage (<em class="parameter"><code><span class="type">guint</span> lid</code></em>);</pre>
694 <div class="refsect3">
695 <a name="gsf-msole-lid-to-codepage.parameters"></a><h4>Parameters</h4>
696 <div class="informaltable"><table class="informaltable" width="100%" border="0">
697 <colgroup>
698 <col width="150px" class="parameters_name">
699 <col class="parameters_description">
700 <col width="200px" class="parameters_annotations">
701 </colgroup>
702 <tbody><tr>
703 <td class="parameter_name"><p>lid</p></td>
704 <td class="parameter_description"><p>numerical language id</p></td>
705 <td class="parameter_annotations"> </td>
706 </tr></tbody>
707 </table></div>
708 </div>
709 <div class="refsect3">
710 <a name="gsf-msole-lid-to-codepage.returns"></a><h4>Returns</h4>
711 <p> our best guess at the codepage for the given language id</p>
712 </div>
713 </div>
714 <hr>
715 <div class="refsect2">
716 <a name="gsf-msole-lid-to-codepage-str"></a><h3>gsf_msole_lid_to_codepage_str ()</h3>
717 <pre class="programlisting"><span class="returnvalue">gchar</span> *
718 gsf_msole_lid_to_codepage_str (<em class="parameter"><code><span class="type">guint</span> lid</code></em>);</pre>
719 <div class="refsect3">
720 <a name="gsf-msole-lid-to-codepage-str.parameters"></a><h4>Parameters</h4>
721 <div class="informaltable"><table class="informaltable" width="100%" border="0">
722 <colgroup>
723 <col width="150px" class="parameters_name">
724 <col class="parameters_description">
725 <col width="200px" class="parameters_annotations">
726 </colgroup>
727 <tbody><tr>
728 <td class="parameter_name"><p>lid</p></td>
729 <td class="parameter_description"><p>numerical language id</p></td>
730 <td class="parameter_annotations"> </td>
731 </tr></tbody>
732 </table></div>
733 </div>
734 <div class="refsect3">
735 <a name="gsf-msole-lid-to-codepage-str.returns"></a><h4>Returns</h4>
736 <p>the Iconv codepage string for the given
737 LID. </p>
738 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
739 </div>
740 </div>
741 <hr>
742 <div class="refsect2">
743 <a name="gsf-msole-lid-for-language"></a><h3>gsf_msole_lid_for_language ()</h3>
744 <pre class="programlisting"><span class="returnvalue">guint</span>
745 gsf_msole_lid_for_language (<em class="parameter"><code><span class="type">char</span> const *lang</code></em>);</pre>
746 <div class="refsect3">
747 <a name="gsf-msole-lid-for-language.parameters"></a><h4>Parameters</h4>
748 <div class="informaltable"><table class="informaltable" width="100%" border="0">
749 <colgroup>
750 <col width="150px" class="parameters_name">
751 <col class="parameters_description">
752 <col width="200px" class="parameters_annotations">
753 </colgroup>
754 <tbody><tr>
755 <td class="parameter_name"><p>lang</p></td>
756 <td class="parameter_description"><p>Language id, i.e., locale name. </p></td>
757 <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>
758 </tr></tbody>
759 </table></div>
760 </div>
761 <div class="refsect3">
762 <a name="gsf-msole-lid-for-language.returns"></a><h4>Returns</h4>
763 <p> the LID (Language Identifier) for the input language.
764 If lang is <code class="literal">NULL</code>, return 0x0400 ("-none-"), and not 0x0000 ("no proofing")</p>
765 </div>
766 </div>
767 <hr>
768 <div class="refsect2">
769 <a name="gsf-msole-language-for-lid"></a><h3>gsf_msole_language_for_lid ()</h3>
770 <pre class="programlisting"><span class="returnvalue">char</span> const *
771 gsf_msole_language_for_lid (<em class="parameter"><code><span class="type">guint</span> lid</code></em>);</pre>
772 <div class="refsect3">
773 <a name="gsf-msole-language-for-lid.parameters"></a><h4>Parameters</h4>
774 <div class="informaltable"><table class="informaltable" width="100%" border="0">
775 <colgroup>
776 <col width="150px" class="parameters_name">
777 <col class="parameters_description">
778 <col width="200px" class="parameters_annotations">
779 </colgroup>
780 <tbody><tr>
781 <td class="parameter_name"><p>lid</p></td>
782 <td class="parameter_description"><p>numerical language id</p></td>
783 <td class="parameter_annotations"> </td>
784 </tr></tbody>
785 </table></div>
786 </div>
787 <div class="refsect3">
788 <a name="gsf-msole-language-for-lid.returns"></a><h4>Returns</h4>
789 <p>the xx_YY style string (can be just xx or
790 xxx) for the given LID. If the LID is not found, is set to 0x0400,
791 or is set to 0x0000, will return "-none-". </p>
792 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
793 </div>
794 </div>
795 <hr>
796 <div class="refsect2">
797 <a name="gsf-msole-inflate"></a><h3>gsf_msole_inflate ()</h3>
798 <pre class="programlisting"><span class="returnvalue">GByteArray</span> *
799 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>,
800 <em class="parameter"><code><a class="link" href="gsf-Utilities.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> offset</code></em>);</pre>
801 <p>Decompresses an LZ compressed stream.</p>
802 <div class="refsect3">
803 <a name="gsf-msole-inflate.parameters"></a><h4>Parameters</h4>
804 <div class="informaltable"><table class="informaltable" width="100%" border="0">
805 <colgroup>
806 <col width="150px" class="parameters_name">
807 <col class="parameters_description">
808 <col width="200px" class="parameters_annotations">
809 </colgroup>
810 <tbody>
811 <tr>
812 <td class="parameter_name"><p>input</p></td>
813 <td class="parameter_description"><p>stream to read from</p></td>
814 <td class="parameter_annotations"> </td>
815 </tr>
816 <tr>
817 <td class="parameter_name"><p>offset</p></td>
818 <td class="parameter_description"><p>offset into it for start byte of compresse stream</p></td>
819 <td class="parameter_annotations"> </td>
820 </tr>
821 </tbody>
822 </table></div>
823 </div>
824 <div class="refsect3">
825 <a name="gsf-msole-inflate.returns"></a><h4>Returns</h4>
826 <p>A GByteArray that the caller is responsible for freeing. </p>
827 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
828 </div>
829 </div>
830 </div>
831 <div class="refsect1">
832 <a name="gsf-MS-OLE2.other_details"></a><h2>Types and Values</h2>
833 <div class="refsect2">
834 <a name="GsfInfileMSOle-struct"></a><h3>GsfInfileMSOle</h3>
835 <pre class="programlisting">typedef struct _GsfInfileMSOle GsfInfileMSOle;</pre>
836 </div>
837 <hr>
838 <div class="refsect2">
839 <a name="GsfOutfileMSOle-struct"></a><h3>GsfOutfileMSOle</h3>
840 <pre class="programlisting">typedef struct _GsfOutfileMSOle GsfOutfileMSOle;</pre>
841 </div>
842 </div>
843 <div class="refsect1">
844 <a name="gsf-MS-OLE2.property-details"></a><h2>Property Details</h2>
845 <div class="refsect2">
846 <a name="GsfOutfileMSOle--big-block-size"></a><h3>The <code class="literal">“big-block-size”</code> property</h3>
847 <pre class="programlisting"> “big-block-size” <span class="type">guint</span></pre>
848 <p>The size of the OLE's big blocks.</p>
849 <p>Owner: GsfOutfileMSOle</p>
850 <p>Flags: Read / Write / Construct Only</p>
851 <p>Allowed values: [128,4096]</p>
852 <p>Default value: 512</p>
853 </div>
854 <hr>
855 <div class="refsect2">
856 <a name="GsfOutfileMSOle--sink"></a><h3>The <code class="literal">“sink”</code> property</h3>
857 <pre class="programlisting"> “sink” <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</pre>
858 <p>The destination for writes.</p>
859 <p>Owner: GsfOutfileMSOle</p>
860 <p>Flags: Read / Write / Construct Only</p>
861 </div>
862 <hr>
863 <div class="refsect2">
864 <a name="GsfOutfileMSOle--small-block-size"></a><h3>The <code class="literal">“small-block-size”</code> property</h3>
865 <pre class="programlisting"> “small-block-size” <span class="type">guint</span></pre>
866 <p>The size of the OLE's small blocks.</p>
867 <p>Owner: GsfOutfileMSOle</p>
868 <p>Flags: Read / Write / Construct Only</p>
869 <p>Allowed values: [8,4096]</p>
870 <p>Default value: 64</p>
871 </div>
872 </div>
873 </div>
874 <div class="footer">
875 <hr>Generated by GTK-Doc V1.34.0</div>
876 </body>
877 </html>