<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libmspack: mskwajd_header 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.12 -->
<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">mskwajd_header Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A structure which represents an KWAJ compressed file.
<a href="structmskwajd__header.html#details">More...</a></p>
<p><code>#include <<a class="el" href="mspack_8h_source.html">mspack.h</a>></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:a3e715be39a9022552f730948d13085ab"><td class="memItemLeft" align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a3e715be39a9022552f730948d13085ab">comp_type</a></td></tr>
<tr class="memdesc:a3e715be39a9022552f730948d13085ab"><td class="mdescLeft"> </td><td class="mdescRight">The compression type; should be one of <a class="el" href="mspack_8h.html#a7a422bbe045d6c4d2137432ccaa87287" title="KWAJ compression type: no compression. ">MSKWAJ_COMP_NONE</a>, <a class="el" href="mspack_8h.html#a1921fcc0b096f13ee40eb78328f8e1c9" title="KWAJ compression type: no compression, 0xFF XOR "encryption". ">MSKWAJ_COMP_XOR</a>, <a class="el" href="mspack_8h.html#a10b39d2b4edb12e70d92ede3b2290cf7" title="KWAJ compression type: LZSS (same method as SZDD) ">MSKWAJ_COMP_SZDD</a> or <a class="el" href="mspack_8h.html#af61a7a99713aab5cbb64bc0d58189e02" title="KWAJ compression type: LZ+Huffman compression. ">MSKWAJ_COMP_LZH</a>. <a href="#a3e715be39a9022552f730948d13085ab">More...</a><br /></td></tr>
<tr class="separator:a3e715be39a9022552f730948d13085ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace36762bb483edb0f8365b6463708d72"><td class="memItemLeft" align="right" valign="top">off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#ace36762bb483edb0f8365b6463708d72">data_offset</a></td></tr>
<tr class="memdesc:ace36762bb483edb0f8365b6463708d72"><td class="mdescLeft"> </td><td class="mdescRight">The offset in the file where the compressed data stream begins. <a href="#ace36762bb483edb0f8365b6463708d72">More...</a><br /></td></tr>
<tr class="separator:ace36762bb483edb0f8365b6463708d72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62b3852fcc90781f98a1017b32679fab"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a62b3852fcc90781f98a1017b32679fab">headers</a></td></tr>
<tr class="memdesc:a62b3852fcc90781f98a1017b32679fab"><td class="mdescLeft"> </td><td class="mdescRight">Flags indicating which optional headers were included. <a href="#a62b3852fcc90781f98a1017b32679fab">More...</a><br /></td></tr>
<tr class="separator:a62b3852fcc90781f98a1017b32679fab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afac7807b7f2ae032cd765ec7b875fef1"><td class="memItemLeft" align="right" valign="top">off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#afac7807b7f2ae032cd765ec7b875fef1">length</a></td></tr>
<tr class="memdesc:afac7807b7f2ae032cd765ec7b875fef1"><td class="mdescLeft"> </td><td class="mdescRight">The amount of uncompressed data in the file, or 0 if not present. <a href="#afac7807b7f2ae032cd765ec7b875fef1">More...</a><br /></td></tr>
<tr class="separator:afac7807b7f2ae032cd765ec7b875fef1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f6bdf2cdb6bf2425327eb3c8a480564"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a1f6bdf2cdb6bf2425327eb3c8a480564">filename</a></td></tr>
<tr class="memdesc:a1f6bdf2cdb6bf2425327eb3c8a480564"><td class="mdescLeft"> </td><td class="mdescRight">output filename, or NULL if not present <a href="#a1f6bdf2cdb6bf2425327eb3c8a480564">More...</a><br /></td></tr>
<tr class="separator:a1f6bdf2cdb6bf2425327eb3c8a480564"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67205e9e87199ec6ce1e1d6569cd077c"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a67205e9e87199ec6ce1e1d6569cd077c">extra</a></td></tr>
<tr class="memdesc:a67205e9e87199ec6ce1e1d6569cd077c"><td class="mdescLeft"> </td><td class="mdescRight">extra uncompressed data (usually text) in the header. <a href="#a67205e9e87199ec6ce1e1d6569cd077c">More...</a><br /></td></tr>
<tr class="separator:a67205e9e87199ec6ce1e1d6569cd077c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a150dd01507ddef57a4d77c5f4f9914fa"><td class="memItemLeft" align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a150dd01507ddef57a4d77c5f4f9914fa">extra_length</a></td></tr>
<tr class="memdesc:a150dd01507ddef57a4d77c5f4f9914fa"><td class="mdescLeft"> </td><td class="mdescRight">length of extra uncompressed data in the header <a href="#a150dd01507ddef57a4d77c5f4f9914fa">More...</a><br /></td></tr>
<tr class="separator:a150dd01507ddef57a4d77c5f4f9914fa"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A structure which represents an KWAJ compressed file. </p>
<p>All fields are READ ONLY. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a3e715be39a9022552f730948d13085ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e715be39a9022552f730948d13085ab">§ </a></span>comp_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short mskwajd_header::comp_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The compression type; should be one of <a class="el" href="mspack_8h.html#a7a422bbe045d6c4d2137432ccaa87287" title="KWAJ compression type: no compression. ">MSKWAJ_COMP_NONE</a>, <a class="el" href="mspack_8h.html#a1921fcc0b096f13ee40eb78328f8e1c9" title="KWAJ compression type: no compression, 0xFF XOR "encryption". ">MSKWAJ_COMP_XOR</a>, <a class="el" href="mspack_8h.html#a10b39d2b4edb12e70d92ede3b2290cf7" title="KWAJ compression type: LZSS (same method as SZDD) ">MSKWAJ_COMP_SZDD</a> or <a class="el" href="mspack_8h.html#af61a7a99713aab5cbb64bc0d58189e02" title="KWAJ compression type: LZ+Huffman compression. ">MSKWAJ_COMP_LZH</a>. </p>
</div>
</div>
<a id="ace36762bb483edb0f8365b6463708d72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace36762bb483edb0f8365b6463708d72">§ </a></span>data_offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">off_t mskwajd_header::data_offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The offset in the file where the compressed data stream begins. </p>
</div>
</div>
<a id="a67205e9e87199ec6ce1e1d6569cd077c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67205e9e87199ec6ce1e1d6569cd077c">§ </a></span>extra</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mskwajd_header::extra</td>
</tr>
</table>
</div><div class="memdoc">
<p>extra uncompressed data (usually text) in the header. </p>
<p>This data can contain nulls so use extra_length to get the size. </p>
</div>
</div>
<a id="a150dd01507ddef57a4d77c5f4f9914fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a150dd01507ddef57a4d77c5f4f9914fa">§ </a></span>extra_length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short mskwajd_header::extra_length</td>
</tr>
</table>
</div><div class="memdoc">
<p>length of extra uncompressed data in the header </p>
</div>
</div>
<a id="a1f6bdf2cdb6bf2425327eb3c8a480564"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f6bdf2cdb6bf2425327eb3c8a480564">§ </a></span>filename</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mskwajd_header::filename</td>
</tr>
</table>
</div><div class="memdoc">
<p>output filename, or NULL if not present </p>
</div>
</div>
<a id="a62b3852fcc90781f98a1017b32679fab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b3852fcc90781f98a1017b32679fab">§ </a></span>headers</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mskwajd_header::headers</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags indicating which optional headers were included. </p>
</div>
</div>
<a id="afac7807b7f2ae032cd765ec7b875fef1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afac7807b7f2ae032cd765ec7b875fef1">§ </a></span>length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">off_t mskwajd_header::length</td>
</tr>
</table>
</div><div class="memdoc">
<p>The amount of uncompressed data in the file, or 0 if not present. </p>
</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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
