You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gnucash/lib/libgsf-1.12.3/doc/html/gsf-MS-OLE2.html

1266 lines
42 KiB

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>MS OLE2</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" 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.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="into.html" title="Part&#160;I.&#160;GSF Overview">
<link rel="part" href="api.html" title="Part&#160;II.&#160;API Reference">
<link rel="chapter" href="io.html" title="Basic Input/Output">
<link rel="chapter" href="sources.html" title="Stream Sources">
<link rel="chapter" href="parsers.html" title="Stream Parsers">
<link rel="chapter" href="misc.html" title="Miscellaneous">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="gsf-Compression.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="parsers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GSF Reference Manual</th>
<td><a accesskey="n" href="gsf-metadata.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="gsf-MS-OLE2"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">MS OLE2</span></h2>
<p>MS OLE2 &#8212; </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<a name="GsfInfileMSOle"></a><a name="GsfOutfileMSOle"></a><pre class="synopsis">
<a href="gsf-MS-OLE2.html#GsfInfileMSOle-struct">GsfInfileMSOle</a>;
<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>* <a href="gsf-MS-OLE2.html#gsf-infile-msole-new">gsf_infile_msole_new</a> (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
GError **err);
gboolean <a href="gsf-MS-OLE2.html#gsf-infile-msole-get-class-id">gsf_infile_msole_get_class_id</a> (<a href="gsf-MS-OLE2.html#GsfInfileMSOle">GsfInfileMSOle</a> const *ole,
guint8 *res);
<a href="gsf-MS-OLE2.html#GsfOutfileMSOle-struct">GsfOutfileMSOle</a>;
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* <a href="gsf-MS-OLE2.html#gsf-outfile-msole-new">gsf_outfile_msole_new</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink);
<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* <a href="gsf-MS-OLE2.html#gsf-outfile-msole-new-full">gsf_outfile_msole_new_full</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
guint bb_size,
guint sb_size);
gboolean <a href="gsf-MS-OLE2.html#gsf-outfile-msole-set-class-id">gsf_outfile_msole_set_class_id</a> (<a href="gsf-MS-OLE2.html#GsfOutfileMSOle">GsfOutfileMSOle</a> *ole,
guint8 const *clsid);
GError* <a href="gsf-MS-OLE2.html#gsf-msole-metadata-read">gsf_msole_metadata_read</a> (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *in,
<a href="gsf-metadata.html#GsfDocMetaData">GsfDocMetaData</a> *accum);
gboolean <a href="gsf-MS-OLE2.html#gsf-msole-metadata-write">gsf_msole_metadata_write</a> (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *out,
<a href="gsf-metadata.html#GsfDocMetaData">GsfDocMetaData</a> const *meta_data,
gboolean doc_not_component);
GIConv <a href="gsf-MS-OLE2.html#gsf-msole-iconv-open-codepages-for-export">gsf_msole_iconv_open_codepages_for_export</a>
(int codepage_to,
char const *from);
GIConv <a href="gsf-MS-OLE2.html#gsf-msole-iconv-open-codepage-for-import">gsf_msole_iconv_open_codepage_for_import</a>
(char const *to,
int codepage);
GIConv <a href="gsf-MS-OLE2.html#gsf-msole-iconv-open-for-export">gsf_msole_iconv_open_for_export</a> (void);
GIConv <a href="gsf-MS-OLE2.html#gsf-msole-iconv-open-codepage-for-export">gsf_msole_iconv_open_codepage_for_export</a>
(int codepage_to);
GIConv <a href="gsf-MS-OLE2.html#gsf-msole-iconv-open-for-import">gsf_msole_iconv_open_for_import</a> (int codepage);
int <a href="gsf-MS-OLE2.html#gsf-msole-iconv-win-codepage">gsf_msole_iconv_win_codepage</a> (void);
guint <a href="gsf-MS-OLE2.html#gsf-msole-codepage-to-lid">gsf_msole_codepage_to_lid</a> (int codepage);
int <a href="gsf-MS-OLE2.html#gsf-msole-lid-to-codepage">gsf_msole_lid_to_codepage</a> (guint lid);
gchar* <a href="gsf-MS-OLE2.html#gsf-msole-lid-to-codepage-str">gsf_msole_lid_to_codepage_str</a> (guint lid);
guint <a href="gsf-MS-OLE2.html#gsf-msole-lid-for-language">gsf_msole_lid_for_language</a> (char const *lang);
charconst * <a href="gsf-MS-OLE2.html#gsf-msole-language-for-lid">gsf_msole_language_for_lid</a> (guint lid);
GByteArray* <a href="gsf-MS-OLE2.html#gsf-msole-inflate">gsf_msole_inflate</a> (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *input,
<a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> offset);
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-START-BAT:CAPS">OLE_HEADER_START_BAT</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-MAJOR-VER:CAPS">OLE_HEADER_MAJOR_VER</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-METABAT-SIZE:CAPS">OLE_HEADER_METABAT_SIZE</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-DIRENT-START:CAPS">OLE_HEADER_DIRENT_START</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-NUM-SBAT:CAPS">OLE_HEADER_NUM_SBAT</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-BB-SHIFT:CAPS">OLE_HEADER_BB_SHIFT</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-CSECTDIR:CAPS">OLE_HEADER_CSECTDIR</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-NUM-BAT:CAPS">OLE_HEADER_NUM_BAT</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-THRESHOLD:CAPS">OLE_HEADER_THRESHOLD</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-METABAT-BLOCK:CAPS">OLE_HEADER_METABAT_BLOCK</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-SBAT-START:CAPS">OLE_HEADER_SBAT_START</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-SIGNATURE:CAPS">OLE_HEADER_SIGNATURE</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-BYTE-ORDER:CAPS">OLE_HEADER_BYTE_ORDER</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-SB-SHIFT:CAPS">OLE_HEADER_SB_SHIFT</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-NUM-METABAT:CAPS">OLE_HEADER_NUM_METABAT</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-SIZE:CAPS">OLE_HEADER_SIZE</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-CLSID:CAPS">OLE_HEADER_CLSID</a>
#define <a href="gsf-MS-OLE2.html#OLE-HEADER-MINOR-VER:CAPS">OLE_HEADER_MINOR_VER</a>
#define <a href="gsf-MS-OLE2.html#OLE-DEFAULT-BB-SHIFT:CAPS">OLE_DEFAULT_BB_SHIFT</a>
#define <a href="gsf-MS-OLE2.html#OLE-DEFAULT-SB-SHIFT:CAPS">OLE_DEFAULT_SB_SHIFT</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-DETAILS-SIZE:CAPS">DIRENT_DETAILS_SIZE</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-SIZE:CAPS">DIRENT_SIZE</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-NAME-LEN:CAPS">DIRENT_NAME_LEN</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-TYPE-PROPERTY:CAPS">DIRENT_TYPE_PROPERTY</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-TYPE-FILE:CAPS">DIRENT_TYPE_FILE</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-MAGIC-END:CAPS">DIRENT_MAGIC_END</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-TYPE-DIR:CAPS">DIRENT_TYPE_DIR</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-MAX-NAME-SIZE:CAPS">DIRENT_MAX_NAME_SIZE</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-FILE-SIZE:CAPS">DIRENT_FILE_SIZE</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-FIRSTBLOCK:CAPS">DIRENT_FIRSTBLOCK</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-TYPE-INVALID:CAPS">DIRENT_TYPE_INVALID</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-USERFLAGS:CAPS">DIRENT_USERFLAGS</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-COLOUR:CAPS">DIRENT_COLOUR</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-MODIFY-TIME:CAPS">DIRENT_MODIFY_TIME</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-TYPE-LOCKBYTES:CAPS">DIRENT_TYPE_LOCKBYTES</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-CREATE-TIME:CAPS">DIRENT_CREATE_TIME</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-PREV:CAPS">DIRENT_PREV</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-NEXT:CAPS">DIRENT_NEXT</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-CHILD:CAPS">DIRENT_CHILD</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-TYPE:CAPS">DIRENT_TYPE</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-CLSID:CAPS">DIRENT_CLSID</a>
#define <a href="gsf-MS-OLE2.html#DIRENT-TYPE-ROOTDIR:CAPS">DIRENT_TYPE_ROOTDIR</a>
#define <a href="gsf-MS-OLE2.html#BAT-MAGIC-METABAT:CAPS">BAT_MAGIC_METABAT</a>
#define <a href="gsf-MS-OLE2.html#BAT-MAGIC-BAT:CAPS">BAT_MAGIC_BAT</a>
#define <a href="gsf-MS-OLE2.html#BAT-INDEX-SIZE:CAPS">BAT_INDEX_SIZE</a>
#define <a href="gsf-MS-OLE2.html#BAT-MAGIC-END-OF-CHAIN:CAPS">BAT_MAGIC_END_OF_CHAIN</a>
#define <a href="gsf-MS-OLE2.html#BAT-MAGIC-UNUSED:CAPS">BAT_MAGIC_UNUSED</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2557928"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
+----<a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
+----GsfInfileMSOle
</pre>
<pre class="synopsis">
GObject
+----<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
+----<a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>
+----GsfOutfileMSOle
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2557987"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2557997"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2558003"></a><h3>
<a name="GsfInfileMSOle-struct"></a>GsfInfileMSOle</h3>
<a class="indexterm" name="id2558014"></a><pre class="programlisting">typedef struct _GsfInfileMSOle GsfInfileMSOle;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558030"></a><h3>
<a name="gsf-infile-msole-new"></a>gsf_infile_msole_new ()</h3>
<a class="indexterm" name="id2558040"></a><pre class="programlisting"><a href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>* gsf_infile_msole_new (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *source,
GError **err);</pre>
<p>
Opens the root directory of an MS OLE file.
NOTE : adds a reference to <em class="parameter"><code>source</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>source</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>err</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>: the new ole file handler
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558127"></a><h3>
<a name="gsf-infile-msole-get-class-id"></a>gsf_infile_msole_get_class_id ()</h3>
<a class="indexterm" name="id2558139"></a><pre class="programlisting">gboolean gsf_infile_msole_get_class_id (<a href="gsf-MS-OLE2.html#GsfInfileMSOle">GsfInfileMSOle</a> const *ole,
guint8 *res);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ole</code></em>&#160;:</span></td>
<td> a <a href="gsf-MS-OLE2.html#GsfInfileMSOle"><span class="type">GsfInfileMSOle</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>res</code></em>&#160;:</span></td>
<td> 16 byte identifier (often a GUID in MS Windows apps)
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>TRUE on success
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558243"></a><h3>
<a name="GsfOutfileMSOle-struct"></a>GsfOutfileMSOle</h3>
<a class="indexterm" name="id2558254"></a><pre class="programlisting">typedef struct _GsfOutfileMSOle GsfOutfileMSOle;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558270"></a><h3>
<a name="gsf-outfile-msole-new"></a>gsf_outfile_msole_new ()</h3>
<a class="indexterm" name="id2558280"></a><pre class="programlisting"><a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* gsf_outfile_msole_new (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink);</pre>
<p>
Creates the root directory of an MS OLE file and manages the addition of
children.
</p>
<p>
NOTE : adds a reference to <em class="parameter"><code>sink</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>sink</code></em>&#160;:</span></td>
<td> a <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the OLE2 file
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>the new ole file handler
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558358"></a><h3>
<a name="gsf-outfile-msole-new-full"></a>gsf_outfile_msole_new_full ()</h3>
<a class="indexterm" name="id2558370"></a><pre class="programlisting"><a href="gsf-Outfile-writing-structed-files.html#GsfOutfile">GsfOutfile</a>* gsf_outfile_msole_new_full (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *sink,
guint bb_size,
guint sb_size);</pre>
<p>
Creates the root directory of an MS OLE file and manages the addition of
children.
</p>
<p>
NOTE : adds a reference to <em class="parameter"><code>sink</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>sink</code></em>&#160;:</span></td>
<td> a <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> to hold the OLE2 file.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>bb_size</code></em>&#160;:</span></td>
<td> size of large blocks.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>sb_size</code></em>&#160;:</span></td>
<td> size of small blocks.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>the new ole file handler
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558491"></a><h3>
<a name="gsf-outfile-msole-set-class-id"></a>gsf_outfile_msole_set_class_id ()</h3>
<a class="indexterm" name="id2558503"></a><pre class="programlisting">gboolean gsf_outfile_msole_set_class_id (<a href="gsf-MS-OLE2.html#GsfOutfileMSOle">GsfOutfileMSOle</a> *ole,
guint8 const *clsid);</pre>
<p>
Write <em class="parameter"><code>clsid</code></em> to the directory associated with <em class="parameter"><code>ole</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ole</code></em>&#160;:</span></td>
<td> a <a href="gsf-MS-OLE2.html#GsfOutfileMSOle"><span class="type">GsfOutfileMSOle</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>clsid</code></em>&#160;:</span></td>
<td> 16 byte identifier (often a GUID in MS Windows apps)
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558605"></a><h3>
<a name="gsf-msole-metadata-read"></a>gsf_msole_metadata_read ()</h3>
<a class="indexterm" name="id2558616"></a><pre class="programlisting">GError* gsf_msole_metadata_read (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *in,
<a href="gsf-metadata.html#GsfDocMetaData">GsfDocMetaData</a> *accum);</pre>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>in</code></em>&#160;:</span></td>
<td> <a href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>accum</code></em>&#160;:</span></td>
<td> <a href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>GError which the caller must free on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558727"></a><h3>
<a name="gsf-msole-metadata-write"></a>gsf_msole_metadata_write ()</h3>
<a class="indexterm" name="id2558737"></a><pre class="programlisting">gboolean gsf_msole_metadata_write (<a href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a> *out,
<a href="gsf-metadata.html#GsfDocMetaData">GsfDocMetaData</a> const *meta_data,
gboolean doc_not_component);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>out</code></em>&#160;:</span></td>
<td> <a href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>meta_data</code></em>&#160;:</span></td>
<td> <a href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>doc_not_component</code></em>&#160;:</span></td>
<td> a kludge to differentiate DocumentSummary from Summary
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>TRUE on success;
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558858"></a><h3>
<a name="gsf-msole-iconv-open-codepages-for-export"></a>gsf_msole_iconv_open_codepages_for_export ()</h3>
<a class="indexterm" name="id2558870"></a><pre class="programlisting">GIConv gsf_msole_iconv_open_codepages_for_export
(int codepage_to,
char const *from);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>codepage_to</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>from</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>an iconv converter to go from utf8 -&gt; to our best guess at a useful
windows codepage.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558952"></a><h3>
<a name="gsf-msole-iconv-open-codepage-for-import"></a>gsf_msole_iconv_open_codepage_for_import ()</h3>
<a class="indexterm" name="id2558964"></a><pre class="programlisting">GIConv gsf_msole_iconv_open_codepage_for_import
(char const *to,
int codepage);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>to</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>codepage</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>an iconv converter for <em class="parameter"><code>codepage</code></em> -&gt; utf8.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559052"></a><h3>
<a name="gsf-msole-iconv-open-for-export"></a>gsf_msole_iconv_open_for_export ()</h3>
<a class="indexterm" name="id2559063"></a><pre class="programlisting">GIConv gsf_msole_iconv_open_for_export (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>an iconv convert to go from utf8 -&gt; to our best guess at a useful
windows codepage.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559104"></a><h3>
<a name="gsf-msole-iconv-open-codepage-for-export"></a>gsf_msole_iconv_open_codepage_for_export ()</h3>
<a class="indexterm" name="id2559115"></a><pre class="programlisting">GIConv gsf_msole_iconv_open_codepage_for_export
(int codepage_to);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>codepage_to</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>an iconv converter to go from utf8 -&gt; to our best guess at a useful
windows codepage.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559177"></a><h3>
<a name="gsf-msole-iconv-open-for-import"></a>gsf_msole_iconv_open_for_import ()</h3>
<a class="indexterm" name="id2559188"></a><pre class="programlisting">GIConv gsf_msole_iconv_open_for_import (int codepage);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>codepage</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>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.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559256"></a><h3>
<a name="gsf-msole-iconv-win-codepage"></a>gsf_msole_iconv_win_codepage ()</h3>
<a class="indexterm" name="id2559268"></a><pre class="programlisting">int gsf_msole_iconv_win_codepage (void);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>our best guess at the applicable windows code page based on an
environment variable or the current locale.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559308"></a><h3>
<a name="gsf-msole-codepage-to-lid"></a>gsf_msole_codepage_to_lid ()</h3>
<a class="indexterm" name="id2559320"></a><pre class="programlisting">guint gsf_msole_codepage_to_lid (int codepage);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>codepage</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559375"></a><h3>
<a name="gsf-msole-lid-to-codepage"></a>gsf_msole_lid_to_codepage ()</h3>
<a class="indexterm" name="id2559386"></a><pre class="programlisting">int gsf_msole_lid_to_codepage (guint lid);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>lid</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>our best guess at the codepage for the given language id
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559445"></a><h3>
<a name="gsf-msole-lid-to-codepage-str"></a>gsf_msole_lid_to_codepage_str ()</h3>
<a class="indexterm" name="id2559457"></a><pre class="programlisting">gchar* gsf_msole_lid_to_codepage_str (guint lid);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>lid</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>the Iconv codepage string for the given LID.
Return value must be <code class="function">g_free()</code>'d
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559528"></a><h3>
<a name="gsf-msole-lid-for-language"></a>gsf_msole_lid_for_language ()</h3>
<a class="indexterm" name="id2559540"></a><pre class="programlisting">guint gsf_msole_lid_for_language (char const *lang);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>lang</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>the LID (Language Identifier) for the input language.
If lang is <code class="literal">null</code>, return 0x0400 ("-none-"), and not 0x0000 ("no proofing")
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559607"></a><h3>
<a name="gsf-msole-language-for-lid"></a>gsf_msole_language_for_lid ()</h3>
<a class="indexterm" name="id2559619"></a><pre class="programlisting">charconst * gsf_msole_language_for_lid (guint lid);</pre>
<p>
</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>lid</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>the xx_YY style string (can be just xx or xxx) for the given LID.
Return value must not be freed. If the LID is not found, is set to 0x0400,
or is set to 0x0000, will return "-none-"
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559680"></a><h3>
<a name="gsf-msole-inflate"></a>gsf_msole_inflate ()</h3>
<a class="indexterm" name="id2559692"></a><pre class="programlisting">GByteArray* gsf_msole_inflate (<a href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a> *input,
<a href="gsf-utils.html#gsf-off-t">gsf_off_t</a> offset);</pre>
<p>
Decompresses an LZ compressed stream.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>input</code></em>&#160;:</span></td>
<td> stream to read from
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset</code></em>&#160;:</span></td>
<td> offset into it for start byte of compresse stream
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A GByteArray that the caller is responsible for freeing
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559775"></a><h3>
<a name="OLE-HEADER-START-BAT:CAPS"></a>OLE_HEADER_START_BAT</h3>
<a class="indexterm" name="id2559785"></a><pre class="programlisting">#define OLE_HEADER_START_BAT 0x4c
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559801"></a><h3>
<a name="OLE-HEADER-MAJOR-VER:CAPS"></a>OLE_HEADER_MAJOR_VER</h3>
<a class="indexterm" name="id2559812"></a><pre class="programlisting">#define OLE_HEADER_MAJOR_VER 0x1a /* 0x3 been seen in wild */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559828"></a><h3>
<a name="OLE-HEADER-METABAT-SIZE:CAPS"></a>OLE_HEADER_METABAT_SIZE</h3>
<a class="indexterm" name="id2559839"></a><pre class="programlisting">#define OLE_HEADER_METABAT_SIZE ((OLE_HEADER_SIZE - OLE_HEADER_START_BAT) / BAT_INDEX_SIZE)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559856"></a><h3>
<a name="OLE-HEADER-DIRENT-START:CAPS"></a>OLE_HEADER_DIRENT_START</h3>
<a class="indexterm" name="id2559867"></a><pre class="programlisting">#define OLE_HEADER_DIRENT_START 0x30
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559882"></a><h3>
<a name="OLE-HEADER-NUM-SBAT:CAPS"></a>OLE_HEADER_NUM_SBAT</h3>
<a class="indexterm" name="id2559894"></a><pre class="programlisting">#define OLE_HEADER_NUM_SBAT 0x40
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559909"></a><h3>
<a name="OLE-HEADER-BB-SHIFT:CAPS"></a>OLE_HEADER_BB_SHIFT</h3>
<a class="indexterm" name="id2559920"></a><pre class="programlisting">#define OLE_HEADER_BB_SHIFT 0x1e
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559936"></a><h3>
<a name="OLE-HEADER-CSECTDIR:CAPS"></a>OLE_HEADER_CSECTDIR</h3>
<a class="indexterm" name="id2559946"></a><pre class="programlisting">#define OLE_HEADER_CSECTDIR 0x28
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559961"></a><h3>
<a name="OLE-HEADER-NUM-BAT:CAPS"></a>OLE_HEADER_NUM_BAT</h3>
<a class="indexterm" name="id2559972"></a><pre class="programlisting">#define OLE_HEADER_NUM_BAT 0x2c
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559987"></a><h3>
<a name="OLE-HEADER-THRESHOLD:CAPS"></a>OLE_HEADER_THRESHOLD</h3>
<a class="indexterm" name="id2559998"></a><pre class="programlisting">#define OLE_HEADER_THRESHOLD 0x38
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560013"></a><h3>
<a name="OLE-HEADER-METABAT-BLOCK:CAPS"></a>OLE_HEADER_METABAT_BLOCK</h3>
<a class="indexterm" name="id2560025"></a><pre class="programlisting">#define OLE_HEADER_METABAT_BLOCK 0x44
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560040"></a><h3>
<a name="OLE-HEADER-SBAT-START:CAPS"></a>OLE_HEADER_SBAT_START</h3>
<a class="indexterm" name="id2560051"></a><pre class="programlisting">#define OLE_HEADER_SBAT_START 0x3c
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560067"></a><h3>
<a name="OLE-HEADER-SIGNATURE:CAPS"></a>OLE_HEADER_SIGNATURE</h3>
<a class="indexterm" name="id2560078"></a><pre class="programlisting">#define OLE_HEADER_SIGNATURE 0x00
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560092"></a><h3>
<a name="OLE-HEADER-BYTE-ORDER:CAPS"></a>OLE_HEADER_BYTE_ORDER</h3>
<a class="indexterm" name="id2560104"></a><pre class="programlisting">#define OLE_HEADER_BYTE_ORDER 0x1c /* 0xfe 0xff == Intel Little Endian */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560120"></a><h3>
<a name="OLE-HEADER-SB-SHIFT:CAPS"></a>OLE_HEADER_SB_SHIFT</h3>
<a class="indexterm" name="id2560131"></a><pre class="programlisting">#define OLE_HEADER_SB_SHIFT 0x20
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560146"></a><h3>
<a name="OLE-HEADER-NUM-METABAT:CAPS"></a>OLE_HEADER_NUM_METABAT</h3>
<a class="indexterm" name="id2560157"></a><pre class="programlisting">#define OLE_HEADER_NUM_METABAT 0x48
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560172"></a><h3>
<a name="OLE-HEADER-SIZE:CAPS"></a>OLE_HEADER_SIZE</h3>
<a class="indexterm" name="id2560184"></a><pre class="programlisting">#define OLE_HEADER_SIZE 0x200 /* independent of big block size size */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560200"></a><h3>
<a name="OLE-HEADER-CLSID:CAPS"></a>OLE_HEADER_CLSID</h3>
<a class="indexterm" name="id2560211"></a><pre class="programlisting">#define OLE_HEADER_CLSID 0x08 /* See ReadClassStg */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560226"></a><h3>
<a name="OLE-HEADER-MINOR-VER:CAPS"></a>OLE_HEADER_MINOR_VER</h3>
<a class="indexterm" name="id2560236"></a><pre class="programlisting">#define OLE_HEADER_MINOR_VER 0x18 /* 0x33 and 0x3e have been seen */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560252"></a><h3>
<a name="OLE-DEFAULT-BB-SHIFT:CAPS"></a>OLE_DEFAULT_BB_SHIFT</h3>
<a class="indexterm" name="id2560263"></a><pre class="programlisting">#define OLE_DEFAULT_BB_SHIFT 9
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560278"></a><h3>
<a name="OLE-DEFAULT-SB-SHIFT:CAPS"></a>OLE_DEFAULT_SB_SHIFT</h3>
<a class="indexterm" name="id2560289"></a><pre class="programlisting">#define OLE_DEFAULT_SB_SHIFT 6
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560304"></a><h3>
<a name="DIRENT-DETAILS-SIZE:CAPS"></a>DIRENT_DETAILS_SIZE</h3>
<a class="indexterm" name="id2560315"></a><pre class="programlisting">#define DIRENT_DETAILS_SIZE 0x40
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560331"></a><h3>
<a name="DIRENT-SIZE:CAPS"></a>DIRENT_SIZE</h3>
<a class="indexterm" name="id2560341"></a><pre class="programlisting">#define DIRENT_SIZE (DIRENT_MAX_NAME_SIZE + DIRENT_DETAILS_SIZE)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560356"></a><h3>
<a name="DIRENT-NAME-LEN:CAPS"></a>DIRENT_NAME_LEN</h3>
<a class="indexterm" name="id2560368"></a><pre class="programlisting">#define DIRENT_NAME_LEN 0x40 /* length in bytes incl 0 terminator */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560384"></a><h3>
<a name="DIRENT-TYPE-PROPERTY:CAPS"></a>DIRENT_TYPE_PROPERTY</h3>
<a class="indexterm" name="id2560394"></a><pre class="programlisting">#define DIRENT_TYPE_PROPERTY 4 /* ? */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560410"></a><h3>
<a name="DIRENT-TYPE-FILE:CAPS"></a>DIRENT_TYPE_FILE</h3>
<a class="indexterm" name="id2560421"></a><pre class="programlisting">#define DIRENT_TYPE_FILE 2
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560436"></a><h3>
<a name="DIRENT-MAGIC-END:CAPS"></a>DIRENT_MAGIC_END</h3>
<a class="indexterm" name="id2560447"></a><pre class="programlisting">#define DIRENT_MAGIC_END 0xffffffff
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560463"></a><h3>
<a name="DIRENT-TYPE-DIR:CAPS"></a>DIRENT_TYPE_DIR</h3>
<a class="indexterm" name="id2560474"></a><pre class="programlisting">#define DIRENT_TYPE_DIR 1
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560488"></a><h3>
<a name="DIRENT-MAX-NAME-SIZE:CAPS"></a>DIRENT_MAX_NAME_SIZE</h3>
<a class="indexterm" name="id2560499"></a><pre class="programlisting">#define DIRENT_MAX_NAME_SIZE 0x40
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560515"></a><h3>
<a name="DIRENT-FILE-SIZE:CAPS"></a>DIRENT_FILE_SIZE</h3>
<a class="indexterm" name="id2560526"></a><pre class="programlisting">#define DIRENT_FILE_SIZE 0x78
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560542"></a><h3>
<a name="DIRENT-FIRSTBLOCK:CAPS"></a>DIRENT_FIRSTBLOCK</h3>
<a class="indexterm" name="id2560552"></a><pre class="programlisting">#define DIRENT_FIRSTBLOCK 0x74
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560567"></a><h3>
<a name="DIRENT-TYPE-INVALID:CAPS"></a>DIRENT_TYPE_INVALID</h3>
<a class="indexterm" name="id2560578"></a><pre class="programlisting">#define DIRENT_TYPE_INVALID 0
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560594"></a><h3>
<a name="DIRENT-USERFLAGS:CAPS"></a>DIRENT_USERFLAGS</h3>
<a class="indexterm" name="id2560604"></a><pre class="programlisting">#define DIRENT_USERFLAGS 0x60 /* only for dirs */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560620"></a><h3>
<a name="DIRENT-COLOUR:CAPS"></a>DIRENT_COLOUR</h3>
<a class="indexterm" name="id2560630"></a><pre class="programlisting">#define DIRENT_COLOUR 0x43
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560646"></a><h3>
<a name="DIRENT-MODIFY-TIME:CAPS"></a>DIRENT_MODIFY_TIME</h3>
<a class="indexterm" name="id2560656"></a><pre class="programlisting">#define DIRENT_MODIFY_TIME 0x6c /* for files */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560672"></a><h3>
<a name="DIRENT-TYPE-LOCKBYTES:CAPS"></a>DIRENT_TYPE_LOCKBYTES</h3>
<a class="indexterm" name="id2560682"></a><pre class="programlisting">#define DIRENT_TYPE_LOCKBYTES 3 /* ? */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560698"></a><h3>
<a name="DIRENT-CREATE-TIME:CAPS"></a>DIRENT_CREATE_TIME</h3>
<a class="indexterm" name="id2560709"></a><pre class="programlisting">#define DIRENT_CREATE_TIME 0x64 /* for files */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560725"></a><h3>
<a name="DIRENT-PREV:CAPS"></a>DIRENT_PREV</h3>
<a class="indexterm" name="id2560735"></a><pre class="programlisting">#define DIRENT_PREV 0x44
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560750"></a><h3>
<a name="DIRENT-NEXT:CAPS"></a>DIRENT_NEXT</h3>
<a class="indexterm" name="id2560760"></a><pre class="programlisting">#define DIRENT_NEXT 0x48
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560775"></a><h3>
<a name="DIRENT-CHILD:CAPS"></a>DIRENT_CHILD</h3>
<a class="indexterm" name="id2560786"></a><pre class="programlisting">#define DIRENT_CHILD 0x4c
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560801"></a><h3>
<a name="DIRENT-TYPE:CAPS"></a>DIRENT_TYPE</h3>
<a class="indexterm" name="id2560812"></a><pre class="programlisting">#define DIRENT_TYPE 0x42
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560826"></a><h3>
<a name="DIRENT-CLSID:CAPS"></a>DIRENT_CLSID</h3>
<a class="indexterm" name="id2560837"></a><pre class="programlisting">#define DIRENT_CLSID 0x50 /* only for dirs */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560853"></a><h3>
<a name="DIRENT-TYPE-ROOTDIR:CAPS"></a>DIRENT_TYPE_ROOTDIR</h3>
<a class="indexterm" name="id2560864"></a><pre class="programlisting">#define DIRENT_TYPE_ROOTDIR 5
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560879"></a><h3>
<a name="BAT-MAGIC-METABAT:CAPS"></a>BAT_MAGIC_METABAT</h3>
<a class="indexterm" name="id2560889"></a><pre class="programlisting">#define BAT_MAGIC_METABAT 0xfffffffc /* a metabat block -4 */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560905"></a><h3>
<a name="BAT-MAGIC-BAT:CAPS"></a>BAT_MAGIC_BAT</h3>
<a class="indexterm" name="id2560915"></a><pre class="programlisting">#define BAT_MAGIC_BAT 0xfffffffd /* a bat block, -3 */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560931"></a><h3>
<a name="BAT-INDEX-SIZE:CAPS"></a>BAT_INDEX_SIZE</h3>
<a class="indexterm" name="id2560942"></a><pre class="programlisting">#define BAT_INDEX_SIZE 4
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560957"></a><h3>
<a name="BAT-MAGIC-END-OF-CHAIN:CAPS"></a>BAT_MAGIC_END_OF_CHAIN</h3>
<a class="indexterm" name="id2560968"></a><pre class="programlisting">#define BAT_MAGIC_END_OF_CHAIN 0xfffffffe /* -2 */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560984"></a><h3>
<a name="BAT-MAGIC-UNUSED:CAPS"></a>BAT_MAGIC_UNUSED</h3>
<a class="indexterm" name="id2560995"></a><pre class="programlisting">#define BAT_MAGIC_UNUSED 0xffffffff /* -1 */
</pre>
<p>
</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="gsf-Compression.html"><b>&lt;&lt;&#160;Compression</b></a></td>
<td align="right"><a accesskey="n" href="gsf-metadata.html"><b>metadata&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>