RubyGems - libmspack - Versions diffs - 0.10.1 → 0.10.1.2 - Mend

libmspack 0.10.1 → 0.10.1.2

Files changed (355) hide show

data/ext/libmspack/doc/html/structmschm__compressor.html DELETED Viewed

@@ -1,226 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
-<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>libmspack: mschm_compressor Struct Reference</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="jquery.js"></script>
-<script type="text/javascript" src="dynsections.js"></script>
-<link href="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="search/searchdata.js"></script>
-<script type="text/javascript" src="search/search.js"></script>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
-  <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">libmspack
-   </div>
-  </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
-<script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
-</script>
-<script type="text/javascript" src="menudata.js"></script>
-<script type="text/javascript" src="menu.js"></script>
-<script type="text/javascript">
-$(function() {
-  initMenu('',true,false,'search.php','Search');
-  $(document).ready(function() { init_search(); });
-});
-</script>
-<div id="main-nav"></div>
-<!-- window showing the filter options -->
-<div id="MSearchSelectWindow"
-     onmouseover="return searchBox.OnSearchSelectShow()"
-     onmouseout="return searchBox.OnSearchSelectHide()"
-     onkeydown="return searchBox.OnSearchSelectKey(event)">
-</div>
-<!-- iframe showing the search results (closed by default) -->
-<div id="MSearchResultsWindow">
-<iframe src="javascript:void(0)" frameborder="0"
-        name="MSearchResults" id="MSearchResults">
-</iframe>
-</div>
-</div><!-- top -->
-<div class="header">
-  <div class="summary">
-<a href="#pub-attribs">Data Fields</a>  </div>
-  <div class="headertitle">
-<div class="title">mschm_compressor Struct Reference</div>  </div>
-</div><!--header-->
-<div class="contents">
-<p>A compressor for .CHM (Microsoft HTMLHelp) files.
- <a href="structmschm__compressor.html#details">More...</a></p>
-<p><code>#include &lt;<a class="el" href="mspack_8h_source.html">mspack.h</a>&gt;</code></p>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
-Data Fields</h2></td></tr>
-<tr class="memitem:adee7fe634e4745b010bd8f71ad7777b0"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0">generate</a> )(struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self, struct <a class="el" href="structmschmc__file.html">mschmc_file</a> file_list[], const char *output_file)</td></tr>
-<tr class="memdesc:adee7fe634e4745b010bd8f71ad7777b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a CHM help file.  <a href="#adee7fe634e4745b010bd8f71ad7777b0">More...</a><br /></td></tr>
-<tr class="separator:adee7fe634e4745b010bd8f71ad7777b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a53e3b040b50b03786db790f7d7bfddd7"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__compressor.html#a53e3b040b50b03786db790f7d7bfddd7">use_temporary_file</a> )(struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self, int use_temp_file, const char *temp_file)</td></tr>
-<tr class="memdesc:a53e3b040b50b03786db790f7d7bfddd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies whether a temporary file is used during CHM generation.  <a href="#a53e3b040b50b03786db790f7d7bfddd7">More...</a><br /></td></tr>
-<tr class="separator:a53e3b040b50b03786db790f7d7bfddd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a2b72f4c7596071a07b0668cb66fac872"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__compressor.html#a2b72f4c7596071a07b0668cb66fac872">set_param</a> )(struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self, int param, int value)</td></tr>
-<tr class="memdesc:a2b72f4c7596071a07b0668cb66fac872"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a CHM compression engine parameter.  <a href="#a2b72f4c7596071a07b0668cb66fac872">More...</a><br /></td></tr>
-<tr class="separator:a2b72f4c7596071a07b0668cb66fac872"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad855497c3aeafa9a2e1631e8d8d03dd9"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__compressor.html#ad855497c3aeafa9a2e1631e8d8d03dd9">last_error</a> )(struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self)</td></tr>
-<tr class="memdesc:ad855497c3aeafa9a2e1631e8d8d03dd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the error code set by the most recently called method.  <a href="#ad855497c3aeafa9a2e1631e8d8d03dd9">More...</a><br /></td></tr>
-<tr class="separator:ad855497c3aeafa9a2e1631e8d8d03dd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>A compressor for .CHM (Microsoft HTMLHelp) files. </p>
-<p>All fields are READ ONLY.</p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="mspack_8h.html#a749d6b350987be706728e020e875b13f" title="Creates a new CHM compressor. ">mspack_create_chm_compressor()</a>, <a class="el" href="mspack_8h.html#a05c47f6572f3966d9495810332356b94" title="Destroys an existing CHM compressor. ">mspack_destroy_chm_compressor()</a> </dd></dl>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a id="adee7fe634e4745b010bd8f71ad7777b0"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#adee7fe634e4745b010bd8f71ad7777b0">&#9670;&nbsp;</a></span>generate</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mschm_compressor::generate) (struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self, struct <a class="el" href="structmschmc__file.html">mschmc_file</a> file_list[], const char *output_file)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Generates a CHM help file. </p>
-<p>The help file will contain up to two sections, an Uncompressed section and potentially an MSCompressed (LZX compressed) section.</p>
-<p>While the contents listing of a CHM file is always in lexical order, the file list passed in will be taken as the correct order for files within the sections. It is in your interest to place similar files together for better compression.</p>
-<p>There are two modes of generation, to use a temporary file or not to use one. See <a class="el" href="structmschm__compressor.html#a53e3b040b50b03786db790f7d7bfddd7" title="Specifies whether a temporary file is used during CHM generation. ">use_temporary_file()</a> for the behaviour of <a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a> in these two different modes.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__compressor.html" title="A compressor for .CHM (Microsoft HTMLHelp) files. ">mschm_compressor</a> instance being called </td></tr>
-    <tr><td class="paramname">file_list</td><td>an array of <a class="el" href="structmschmc__file.html" title="A structure which represents a file to be placed in a CHM helpfile. ">mschmc_file</a> structures, terminated with an entry whose <a class="el" href="structmschmc__file.html#a11c5bd77b0142d3c3a94c5a24126e030" title="One of MSCHMC_ENDLIST, MSCHMC_UNCOMP or MSCHMC_MSCOMP. ">mschmc_file::section</a> field is <a class="el" href="mspack_8h.html#a80f996d3fbc7800630b9542d5e4620ec" title="mschmc_file::section value: end of CHM file list ">MSCHMC_ENDLIST</a>. The order of the list is preserved within each section. The length of any <a class="el" href="structmschmc__file.html#ab2979483302579db0111fe5cff3d4eb5" title="The full path and filename of the file within the CHM helpfile, a UTF-1 encoded null-terminated strin...">mschmc_file::chm_filename</a> string cannot exceed roughly 4096 bytes. Each source file must be able to supply as many bytes as given in the <a class="el" href="structmschmc__file.html#aee5c029845e1ce6112c8d050d9b23fda" title="The length of the file, in bytes. ">mschmc_file::length</a> field. </td></tr>
-    <tr><td class="paramname">output_file</td><td>the file to write the generated CHM helpfile to. This is passed directly to <a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a> </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>an error code, or MSPACK_ERR_OK if successful </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__compressor.html#a53e3b040b50b03786db790f7d7bfddd7" title="Specifies whether a temporary file is used during CHM generation. ">use_temporary_file()</a> <a class="el" href="structmschm__compressor.html#a2b72f4c7596071a07b0668cb66fac872" title="Sets a CHM compression engine parameter. ">set_param()</a> </dd></dl>
-</div>
-</div>
-<a id="ad855497c3aeafa9a2e1631e8d8d03dd9"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ad855497c3aeafa9a2e1631e8d8d03dd9">&#9670;&nbsp;</a></span>last_error</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mschm_compressor::last_error) (struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Returns the error code set by the most recently called method. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__compressor.html" title="A compressor for .CHM (Microsoft HTMLHelp) files. ">mschm_compressor</a> instance being called </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>the most recent error code </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__compressor.html#a2b72f4c7596071a07b0668cb66fac872" title="Sets a CHM compression engine parameter. ">set_param()</a>, <a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a> </dd></dl>
-</div>
-</div>
-<a id="a2b72f4c7596071a07b0668cb66fac872"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a2b72f4c7596071a07b0668cb66fac872">&#9670;&nbsp;</a></span>set_param</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mschm_compressor::set_param) (struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self, int param, int value)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Sets a CHM compression engine parameter. </p>
-<p>The following parameters are defined:</p>
-<ul>
-<li><a class="el" href="mspack_8h.html#aa33210e31d2272c1c015849281bc8028" title="mschm_compressor::set_param() parameter: &quot;timestamp&quot; header ">MSCHMC_PARAM_TIMESTAMP</a>: Sets the "timestamp" of the CHM file generated. This is not a timestamp, see <a class="el" href="structmschmd__header.html#ab844b2365051d8c99ce41ae0a0f4c106" title="The &quot;timestamp&quot; of the CHM helpfile. ">mschmd_header::timestamp</a> for a description. If this timestamp is 0, <a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a> will use its own algorithm for making a unique ID, based on the lengths and names of files in the CHM itself. Defaults to 0, any value between 0 and (2^32)-1 is valid.</li>
-<li><a class="el" href="mspack_8h.html#a0ad26bd80adf64598352066814153335" title="mschm_compressor::set_param() parameter: &quot;language&quot; header ">MSCHMC_PARAM_LANGUAGE</a>: Sets the "language" of the CHM file generated. This is not the language used in the CHM file, but the language setting of the user who ran the HTMLHelp compiler. It defaults to 0x0409. The valid range is between 0x0000 and 0x7F7F.</li>
-<li><a class="el" href="mspack_8h.html#a0ee4a588079a3f6bf65b63ce388c9a45" title="mschm_compressor::set_param() parameter: LZX window size ">MSCHMC_PARAM_LZXWINDOW</a>: Sets the size of the LZX history window, which is also the interval at which the compressed data stream can be randomly accessed. The value is not a size in bytes, but a power of two. The default value is 16 (which makes the window 2^16 bytes, or 64 kilobytes), the valid range is from 15 (32 kilobytes) to 21 (2 megabytes).</li>
-<li><a class="el" href="mspack_8h.html#ad17047eb4450c7476d29d47fb5f1ce35" title="mschm_compressor::set_param() parameter: intra-chunk quickref density ">MSCHMC_PARAM_DENSITY</a>: Sets the "density" of quick reference entries stored at the end of directory listing chunk. Each chunk is 4096 bytes in size, and contains as many file entries as there is room for. At the other end of the chunk, a list of "quick reference" pointers is included. The offset of every 'N'th file entry is given a quick reference, where N = (2^density) + 1. The default density is<ol type="1">
-<li>The smallest density is 0 (N=2), the maximum is 10 (N=1025). As each file entry requires at least 5 bytes, the maximum number of entries in a single chunk is roughly 800, so the maximum value 10 can be used to indicate there are no quickrefs at all.</li>
-</ol>
-</li>
-<li><a class="el" href="mspack_8h.html#ac6c61f24c4d9ad2a5a9bcdbb8057723a" title="mschm_compressor::set_param() parameter: whether to create indices ">MSCHMC_PARAM_INDEX</a>: Sets whether or not to include quick lookup index chunk(s), in addition to normal directory listing chunks. A value of zero means no index chunks will be created, a non-zero value means index chunks will be created. The default is zero, "don't
-  create an index".</li>
-</ul>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__compressor.html" title="A compressor for .CHM (Microsoft HTMLHelp) files. ">mschm_compressor</a> instance being called </td></tr>
-    <tr><td class="paramname">param</td><td>the parameter to set </td></tr>
-    <tr><td class="paramname">value</td><td>the value to set the parameter to </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>MSPACK_ERR_OK if all is OK, or MSPACK_ERR_ARGS if there is a problem with either parameter or value. </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a> </dd></dl>
-</div>
-</div>
-<a id="a53e3b040b50b03786db790f7d7bfddd7"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a53e3b040b50b03786db790f7d7bfddd7">&#9670;&nbsp;</a></span>use_temporary_file</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mschm_compressor::use_temporary_file) (struct <a class="el" href="structmschm__compressor.html">mschm_compressor</a> *self, int use_temp_file, const char *temp_file)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Specifies whether a temporary file is used during CHM generation. </p>
-<p>The CHM file format includes data about the compressed section (such as its overall size) that is stored in the output CHM file prior to the compressed section itself. This unavoidably requires that the compressed section has to be generated, before these details can be set. There are several ways this can be handled. Firstly, the compressed section could be generated entirely in memory before writing any of the output CHM file. This approach is not used in libmspack, as the compressed section can exceed the addressable memory space on most architectures.</p>
-<p>libmspack has two options, either to write these unknowable sections with blank data, generate the compressed section, then re-open the output file for update once the compressed section has been completed, or to write the compressed section to a temporary file, then write the entire output file at once, performing a simple file-to-file copy for the compressed section.</p>
-<p>The simple solution of buffering the entire compressed section in memory can still be used, if desired. As the temporary file's filename is passed directly to <a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a>, it is possible for a custom <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> implementation to hold this file in memory, without writing to a disk.</p>
-<p>If a temporary file is set, <a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a> performs the following sequence of events: the temporary file is opened for writing, the compression algorithm writes to the temporary file, the temporary file is closed. Then the output file is opened for writing and the temporary file is re-opened for reading. The output file is written and the temporary file is read from. Both files are then closed. The temporary file itself is not deleted. If that is desired, the temporary file should be deleted after the completion of <a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a>, if it exists.</p>
-<p>If a temporary file is set not to be used, <a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a> performs the following sequence of events: the output file is opened for writing, then it is written and closed. The output file is then re-opened for update, the appropriate sections are seek()ed to and re-written, then the output file is closed.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__compressor.html" title="A compressor for .CHM (Microsoft HTMLHelp) files. ">mschm_compressor</a> instance being called </td></tr>
-    <tr><td class="paramname">use_temp_file</td><td>non-zero if the temporary file should be used, zero if the temporary file should not be used. </td></tr>
-    <tr><td class="paramname">temp_file</td><td>a file to temporarily write compressed data to, before opening it for reading and copying the contents to the output file. This is passed directly to <a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a>. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>an error code, or MSPACK_ERR_OK if successful </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__compressor.html#adee7fe634e4745b010bd8f71ad7777b0" title="Generates a CHM help file. ">generate()</a> </dd></dl>
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following file:<ul>
-<li><a class="el" href="mspack_8h_source.html">mspack.h</a></li>
-</ul>
-</div><!-- contents -->
-<!-- start footer part -->
-<hr class="footer"/><address class="footer"><small>
-Generated by &#160;<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.13
-</small></address>
-</body>
-</html>

data/ext/libmspack/doc/html/structmschm__decompressor.html DELETED Viewed

@@ -1,299 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
-<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>libmspack: mschm_decompressor Struct Reference</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="jquery.js"></script>
-<script type="text/javascript" src="dynsections.js"></script>
-<link href="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="search/searchdata.js"></script>
-<script type="text/javascript" src="search/search.js"></script>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
-  <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">libmspack
-   </div>
-  </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
-<script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
-</script>
-<script type="text/javascript" src="menudata.js"></script>
-<script type="text/javascript" src="menu.js"></script>
-<script type="text/javascript">
-$(function() {
-  initMenu('',true,false,'search.php','Search');
-  $(document).ready(function() { init_search(); });
-});
-</script>
-<div id="main-nav"></div>
-<!-- window showing the filter options -->
-<div id="MSearchSelectWindow"
-     onmouseover="return searchBox.OnSearchSelectShow()"
-     onmouseout="return searchBox.OnSearchSelectHide()"
-     onkeydown="return searchBox.OnSearchSelectKey(event)">
-</div>
-<!-- iframe showing the search results (closed by default) -->
-<div id="MSearchResultsWindow">
-<iframe src="javascript:void(0)" frameborder="0"
-        name="MSearchResults" id="MSearchResults">
-</iframe>
-</div>
-</div><!-- top -->
-<div class="header">
-  <div class="summary">
-<a href="#pub-attribs">Data Fields</a>  </div>
-  <div class="headertitle">
-<div class="title">mschm_decompressor Struct Reference</div>  </div>
-</div><!--header-->
-<div class="contents">
-<p>A decompressor for .CHM (Microsoft HTMLHelp) files.
- <a href="structmschm__decompressor.html#details">More...</a></p>
-<p><code>#include &lt;<a class="el" href="mspack_8h_source.html">mspack.h</a>&gt;</code></p>
-<div class="dynheader">
-Collaboration diagram for mschm_decompressor:</div>
-<div class="dyncontent">
-<div class="center"><img src="structmschm__decompressor__coll__graph.png" border="0" usemap="#mschm__decompressor_coll__map" alt="Collaboration graph"/></div>
-<map name="mschm__decompressor_coll__map" id="mschm__decompressor_coll__map">
-<area shape="rect" id="node2" href="structmschmd__header.html" title="A structure which represents a CHM helpfile. " alt="" coords="279,5,398,32"/>
-<area shape="rect" id="node4" href="structmschmd__section.html" title="A structure which represents a section of a CHM helpfile. " alt="" coords="278,111,399,137"/>
-<area shape="rect" id="node3" href="structmschmd__file.html" title="A structure which represents a file stored in a CHM helpfile. " alt="" coords="136,201,232,228"/>
-<area shape="rect" id="node5" href="structmschmd__sec__mscompressed.html" title="A structure which represents the LZX compressed section of a CHM helpfile. " alt="" coords="235,335,431,361"/>
-<area shape="rect" id="node6" href="structmschmd__sec__uncompressed.html" title="A structure which represents the uncompressed section of a CHM helpfile. " alt="" coords="391,201,583,228"/>
-</map>
-<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
-Data Fields</h2></td></tr>
-<tr class="memitem:ac43207276b00521cde8014353ae16f34"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmschmd__header.html">mschmd_header</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34">open</a> )(struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, const char *filename)</td></tr>
-<tr class="memdesc:ac43207276b00521cde8014353ae16f34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a CHM helpfile and reads its contents.  <a href="#ac43207276b00521cde8014353ae16f34">More...</a><br /></td></tr>
-<tr class="separator:ac43207276b00521cde8014353ae16f34"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aa3ead0cd30ee28cbe13ee05210162b5c"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__decompressor.html#aa3ead0cd30ee28cbe13ee05210162b5c">close</a> )(struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, struct <a class="el" href="structmschmd__header.html">mschmd_header</a> *chm)</td></tr>
-<tr class="memdesc:aa3ead0cd30ee28cbe13ee05210162b5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes a previously opened CHM helpfile.  <a href="#aa3ead0cd30ee28cbe13ee05210162b5c">More...</a><br /></td></tr>
-<tr class="separator:aa3ead0cd30ee28cbe13ee05210162b5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a9809c5a004f6377d8889af18a7448213"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__decompressor.html#a9809c5a004f6377d8889af18a7448213">extract</a> )(struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, struct <a class="el" href="structmschmd__file.html">mschmd_file</a> *file, const char *filename)</td></tr>
-<tr class="memdesc:a9809c5a004f6377d8889af18a7448213"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts a file from a CHM helpfile.  <a href="#a9809c5a004f6377d8889af18a7448213">More...</a><br /></td></tr>
-<tr class="separator:a9809c5a004f6377d8889af18a7448213"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae7c840a5374a0c916daf5c33a884fefa"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__decompressor.html#ae7c840a5374a0c916daf5c33a884fefa">last_error</a> )(struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self)</td></tr>
-<tr class="memdesc:ae7c840a5374a0c916daf5c33a884fefa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the error code set by the most recently called method.  <a href="#ae7c840a5374a0c916daf5c33a884fefa">More...</a><br /></td></tr>
-<tr class="separator:ae7c840a5374a0c916daf5c33a884fefa"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae7df232ac27eded95850fea2648985f9"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmschmd__header.html">mschmd_header</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__decompressor.html#ae7df232ac27eded95850fea2648985f9">fast_open</a> )(struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, const char *filename)</td></tr>
-<tr class="memdesc:ae7df232ac27eded95850fea2648985f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a CHM helpfile quickly.  <a href="#ae7df232ac27eded95850fea2648985f9">More...</a><br /></td></tr>
-<tr class="separator:ae7df232ac27eded95850fea2648985f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5d80bc6dc6c08ae0ae064e66e73c48f8"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschm__decompressor.html#a5d80bc6dc6c08ae0ae064e66e73c48f8">fast_find</a> )(struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, struct <a class="el" href="structmschmd__header.html">mschmd_header</a> *chm, const char *filename, struct <a class="el" href="structmschmd__file.html">mschmd_file</a> *f_ptr, int f_size)</td></tr>
-<tr class="memdesc:a5d80bc6dc6c08ae0ae064e66e73c48f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds file details quickly.  <a href="#a5d80bc6dc6c08ae0ae064e66e73c48f8">More...</a><br /></td></tr>
-<tr class="separator:a5d80bc6dc6c08ae0ae064e66e73c48f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>A decompressor for .CHM (Microsoft HTMLHelp) files. </p>
-<p>All fields are READ ONLY.</p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="mspack_8h.html#a5829a2023927ad4dc8bd452f3b294851" title="Creates a new CHM decompressor. ">mspack_create_chm_decompressor()</a>, <a class="el" href="mspack_8h.html#a50c0799f5c1a128672c024a05c79cac8" title="Destroys an existing CHM decompressor. ">mspack_destroy_chm_decompressor()</a> </dd></dl>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a id="aa3ead0cd30ee28cbe13ee05210162b5c"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#aa3ead0cd30ee28cbe13ee05210162b5c">&#9670;&nbsp;</a></span>close</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void(* mschm_decompressor::close) (struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, struct <a class="el" href="structmschmd__header.html">mschmd_header</a> *chm)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Closes a previously opened CHM helpfile. </p>
-<p>This closes a CHM helpfile, frees the <a class="el" href="structmschmd__header.html" title="A structure which represents a CHM helpfile. ">mschmd_header</a> and all <a class="el" href="structmschmd__file.html" title="A structure which represents a file stored in a CHM helpfile. ">mschmd_file</a> structures associated with it (if any). This works on both helpfiles opened with <a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a> and helpfiles opened with <a class="el" href="structmschm__decompressor.html#ae7df232ac27eded95850fea2648985f9" title="Opens a CHM helpfile quickly. ">fast_open()</a>.</p>
-<p>The CHM header pointer is now invalid and cannot be used again. All <a class="el" href="structmschmd__file.html" title="A structure which represents a file stored in a CHM helpfile. ">mschmd_file</a> pointers referencing that CHM are also now invalid, and cannot be used again.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__decompressor.html" title="A decompressor for .CHM (Microsoft HTMLHelp) files. ">mschm_decompressor</a> instance being called </td></tr>
-    <tr><td class="paramname">chm</td><td>the CHM helpfile to close </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a>, <a class="el" href="structmschm__decompressor.html#ae7df232ac27eded95850fea2648985f9" title="Opens a CHM helpfile quickly. ">fast_open()</a> </dd></dl>
-</div>
-</div>
-<a id="a9809c5a004f6377d8889af18a7448213"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a9809c5a004f6377d8889af18a7448213">&#9670;&nbsp;</a></span>extract</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mschm_decompressor::extract) (struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, struct <a class="el" href="structmschmd__file.html">mschmd_file</a> *file, const char *filename)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Extracts a file from a CHM helpfile. </p>
-<p>This extracts a file from a CHM helpfile and writes it to the given filename. The filename of the file, <a class="el" href="structmscabd__file.html#a181b45655523f55ed114b51249d305f8" title="The filename of the file. ">mscabd_file::filename</a>, is not used by <a class="el" href="structmschm__decompressor.html#a9809c5a004f6377d8889af18a7448213" title="Extracts a file from a CHM helpfile. ">extract()</a>, but can be used by the caller as a guide for constructing an appropriate filename.</p>
-<p>This method works both with files found in the <a class="el" href="structmschmd__header.html#aecdd3b5e84606785e9620a70e8f0d0ed" title="A list of all non-system files in the CHM helpfile. ">mschmd_header::files</a> and <a class="el" href="structmschmd__header.html#ac38b56f77e2a44d998e57ba9301e39d5" title="A list of all system files in the CHM helpfile. ">mschmd_header::sysfiles</a> list and <a class="el" href="structmschmd__file.html" title="A structure which represents a file stored in a CHM helpfile. ">mschmd_file</a> structures generated on the fly by <a class="el" href="structmschm__decompressor.html#a5d80bc6dc6c08ae0ae064e66e73c48f8" title="Finds file details quickly. ">fast_find()</a>.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__decompressor.html" title="A decompressor for .CHM (Microsoft HTMLHelp) files. ">mschm_decompressor</a> instance being called </td></tr>
-    <tr><td class="paramname">file</td><td>the file to be decompressed </td></tr>
-    <tr><td class="paramname">filename</td><td>the filename of the file being written to </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>an error code, or MSPACK_ERR_OK if successful </dd></dl>
-</div>
-</div>
-<a id="a5d80bc6dc6c08ae0ae064e66e73c48f8"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a5d80bc6dc6c08ae0ae064e66e73c48f8">&#9670;&nbsp;</a></span>fast_find</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mschm_decompressor::fast_find) (struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, struct <a class="el" href="structmschmd__header.html">mschmd_header</a> *chm, const char *filename, struct <a class="el" href="structmschmd__file.html">mschmd_file</a> *f_ptr, int f_size)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Finds file details quickly. </p>
-<p>Instead of reading all CHM helpfile headers and building a list of files, <a class="el" href="structmschm__decompressor.html#ae7df232ac27eded95850fea2648985f9" title="Opens a CHM helpfile quickly. ">fast_open()</a> and <a class="el" href="structmschm__decompressor.html#a5d80bc6dc6c08ae0ae064e66e73c48f8" title="Finds file details quickly. ">fast_find()</a> are intended for finding file details only when they are needed. The CHM file format includes an on-disk file index to allow this.</p>
-<p>Given a case-sensitive filename, <a class="el" href="structmschm__decompressor.html#a5d80bc6dc6c08ae0ae064e66e73c48f8" title="Finds file details quickly. ">fast_find()</a> will search the on-disk index for that file.</p>
-<p>If the file was found, the caller-provided <a class="el" href="structmschmd__file.html" title="A structure which represents a file stored in a CHM helpfile. ">mschmd_file</a> structure will be filled out like so:</p><ul>
-<li>section: the correct value for the found file</li>
-<li>offset: the correct value for the found file</li>
-<li>length: the correct value for the found file</li>
-<li>all other structure elements: NULL or 0</li>
-</ul>
-<p>If the file was not found, MSPACK_ERR_OK will still be returned as the result, but the caller-provided structure will be filled out like so:</p><ul>
-<li>section: NULL</li>
-<li>offset: 0</li>
-<li>length: 0</li>
-<li>all other structure elements: NULL or 0</li>
-</ul>
-<p>This method is intended to be used in conjunction with CHM helpfiles opened with <a class="el" href="structmschm__decompressor.html#ae7df232ac27eded95850fea2648985f9" title="Opens a CHM helpfile quickly. ">fast_open()</a>, but it also works with helpfiles opened using the regular <a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a>.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__decompressor.html" title="A decompressor for .CHM (Microsoft HTMLHelp) files. ">mschm_decompressor</a> instance being called </td></tr>
-    <tr><td class="paramname">chm</td><td>the CHM helpfile to search for the file </td></tr>
-    <tr><td class="paramname">filename</td><td>the filename of the file to search for </td></tr>
-    <tr><td class="paramname">f_ptr</td><td>a pointer to a caller-provded <a class="el" href="structmschmd__file.html" title="A structure which represents a file stored in a CHM helpfile. ">mschmd_file</a> structure </td></tr>
-    <tr><td class="paramname">f_size</td><td><code>sizeof(struct mschmd_file)</code> </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>an error code, or MSPACK_ERR_OK if successful </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a>, <a class="el" href="structmschm__decompressor.html#aa3ead0cd30ee28cbe13ee05210162b5c" title="Closes a previously opened CHM helpfile. ">close()</a>, <a class="el" href="structmschm__decompressor.html#a5d80bc6dc6c08ae0ae064e66e73c48f8" title="Finds file details quickly. ">fast_find()</a>, <a class="el" href="structmschm__decompressor.html#a9809c5a004f6377d8889af18a7448213" title="Extracts a file from a CHM helpfile. ">extract()</a> </dd></dl>
-</div>
-</div>
-<a id="ae7df232ac27eded95850fea2648985f9"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae7df232ac27eded95850fea2648985f9">&#9670;&nbsp;</a></span>fast_open</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">struct <a class="el" href="structmschmd__header.html">mschmd_header</a>*(* mschm_decompressor::fast_open) (struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, const char *filename)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Opens a CHM helpfile quickly. </p>
-<p>If the file opened is a valid CHM helpfile, only essential headers will be read. A <a class="el" href="structmschmd__header.html" title="A structure which represents a CHM helpfile. ">mschmd_header</a> structure will be still be returned, as with <a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a>, but the <a class="el" href="structmschmd__header.html#aecdd3b5e84606785e9620a70e8f0d0ed" title="A list of all non-system files in the CHM helpfile. ">mschmd_header::files</a> field will be NULL. No files details will be automatically read. The <a class="el" href="structmschm__decompressor.html#a5d80bc6dc6c08ae0ae064e66e73c48f8" title="Finds file details quickly. ">fast_find()</a> method must be used to obtain file details.</p>
-<p>In the case of an error occuring, NULL is returned and the error code is available from <a class="el" href="structmschm__decompressor.html#ae7c840a5374a0c916daf5c33a884fefa" title="Returns the error code set by the most recently called method. ">last_error()</a>.</p>
-<p>The filename pointer should be considered "in use" until <a class="el" href="structmschm__decompressor.html#aa3ead0cd30ee28cbe13ee05210162b5c" title="Closes a previously opened CHM helpfile. ">close()</a> is called on the CHM helpfile.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__decompressor.html" title="A decompressor for .CHM (Microsoft HTMLHelp) files. ">mschm_decompressor</a> instance being called </td></tr>
-    <tr><td class="paramname">filename</td><td>the filename of the CHM helpfile. This is passed directly to <a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a>. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>a pointer to a <a class="el" href="structmschmd__header.html" title="A structure which represents a CHM helpfile. ">mschmd_header</a> structure, or NULL on failure </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a>, <a class="el" href="structmschm__decompressor.html#aa3ead0cd30ee28cbe13ee05210162b5c" title="Closes a previously opened CHM helpfile. ">close()</a>, <a class="el" href="structmschm__decompressor.html#a5d80bc6dc6c08ae0ae064e66e73c48f8" title="Finds file details quickly. ">fast_find()</a>, <a class="el" href="structmschm__decompressor.html#a9809c5a004f6377d8889af18a7448213" title="Extracts a file from a CHM helpfile. ">extract()</a> </dd></dl>
-</div>
-</div>
-<a id="ae7c840a5374a0c916daf5c33a884fefa"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae7c840a5374a0c916daf5c33a884fefa">&#9670;&nbsp;</a></span>last_error</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mschm_decompressor::last_error) (struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Returns the error code set by the most recently called method. </p>
-<p>This is useful for <a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a> and <a class="el" href="structmschm__decompressor.html#ae7df232ac27eded95850fea2648985f9" title="Opens a CHM helpfile quickly. ">fast_open()</a>, which do not return an error code directly.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__decompressor.html" title="A decompressor for .CHM (Microsoft HTMLHelp) files. ">mschm_decompressor</a> instance being called </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>the most recent error code </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__decompressor.html#ac43207276b00521cde8014353ae16f34" title="Opens a CHM helpfile and reads its contents. ">open()</a>, <a class="el" href="structmschm__decompressor.html#a9809c5a004f6377d8889af18a7448213" title="Extracts a file from a CHM helpfile. ">extract()</a> </dd></dl>
-</div>
-</div>
-<a id="ac43207276b00521cde8014353ae16f34"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ac43207276b00521cde8014353ae16f34">&#9670;&nbsp;</a></span>open</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">struct <a class="el" href="structmschmd__header.html">mschmd_header</a>*(* mschm_decompressor::open) (struct <a class="el" href="structmschm__decompressor.html">mschm_decompressor</a> *self, const char *filename)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Opens a CHM helpfile and reads its contents. </p>
-<p>If the file opened is a valid CHM helpfile, all headers will be read and a <a class="el" href="structmschmd__header.html" title="A structure which represents a CHM helpfile. ">mschmd_header</a> structure will be returned, with a full list of files.</p>
-<p>In the case of an error occuring, NULL is returned and the error code is available from <a class="el" href="structmschm__decompressor.html#ae7c840a5374a0c916daf5c33a884fefa" title="Returns the error code set by the most recently called method. ">last_error()</a>.</p>
-<p>The filename pointer should be considered "in use" until <a class="el" href="structmschm__decompressor.html#aa3ead0cd30ee28cbe13ee05210162b5c" title="Closes a previously opened CHM helpfile. ">close()</a> is called on the CHM helpfile.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmschm__decompressor.html" title="A decompressor for .CHM (Microsoft HTMLHelp) files. ">mschm_decompressor</a> instance being called </td></tr>
-    <tr><td class="paramname">filename</td><td>the filename of the CHM helpfile. This is passed directly to <a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a>. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>a pointer to a <a class="el" href="structmschmd__header.html" title="A structure which represents a CHM helpfile. ">mschmd_header</a> structure, or NULL on failure </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmschm__decompressor.html#aa3ead0cd30ee28cbe13ee05210162b5c" title="Closes a previously opened CHM helpfile. ">close()</a> </dd></dl>
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following file:<ul>
-<li><a class="el" href="mspack_8h_source.html">mspack.h</a></li>
-</ul>
-</div><!-- contents -->
-<!-- start footer part -->
-<hr class="footer"/><address class="footer"><small>
-Generated by &#160;<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.13
-</small></address>
-</body>
-</html>

data/ext/libmspack/doc/html/structmschm__decompressor__coll__graph.map DELETED Viewed

@@ -1,7 +0,0 @@
-<map id="mschm_decompressor" name="mschm_decompressor">
-<area shape="rect" id="node2" href="$structmschmd__header.html" title="A structure which represents a CHM helpfile. " alt="" coords="279,5,398,32"/>
-<area shape="rect" id="node4" href="$structmschmd__section.html" title="A structure which represents a section of a CHM helpfile. " alt="" coords="278,111,399,137"/>
-<area shape="rect" id="node3" href="$structmschmd__file.html" title="A structure which represents a file stored in a CHM helpfile. " alt="" coords="136,201,232,228"/>
-<area shape="rect" id="node5" href="$structmschmd__sec__mscompressed.html" title="A structure which represents the LZX compressed section of a CHM helpfile. " alt="" coords="235,335,431,361"/>
-<area shape="rect" id="node6" href="$structmschmd__sec__uncompressed.html" title="A structure which represents the uncompressed section of a CHM helpfile. " alt="" coords="391,201,583,228"/>
-</map>

data/ext/libmspack/doc/html/structmschm__decompressor__coll__graph.md5 DELETED Viewed

	@@ -1 +0,0 @@
1	- 3b9184fce03f52b858c1b3d7698b4614

data/ext/libmspack/doc/html/structmschm__decompressor__coll__graph.png DELETED Viewed

Binary file