File: structmsszdd__decompressor.html

package info (click to toggle)
libmspack 0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 3,916 kB
  • sloc: sh: 11,332; ansic: 7,879; perl: 131; makefile: 97
file content (250 lines) | stat: -rw-r--r-- 18,648 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
<!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.6"/>
<title>libmspack: msszdd_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/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
   <div id="projectname">libmspack
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a></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">msszdd_decompressor Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A decompressor for SZDD compressed files.  
 <a href="structmsszdd__decompressor.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:afb164f3bff4752cc93c9cec90ffb42bc"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmsszddd__header.html">msszddd_header</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsszdd__decompressor.html#afb164f3bff4752cc93c9cec90ffb42bc">open</a> )(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, const char *filename)</td></tr>
<tr class="memdesc:afb164f3bff4752cc93c9cec90ffb42bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a SZDD file and reads the header.  <a href="#afb164f3bff4752cc93c9cec90ffb42bc">More...</a><br/></td></tr>
<tr class="separator:afb164f3bff4752cc93c9cec90ffb42bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a2c9aa3d5f85b4ea247130ddabbd490"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsszdd__decompressor.html#a9a2c9aa3d5f85b4ea247130ddabbd490">close</a> )(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, struct <a class="el" href="structmsszddd__header.html">msszddd_header</a> *szdd)</td></tr>
<tr class="memdesc:a9a2c9aa3d5f85b4ea247130ddabbd490"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes a previously opened SZDD file.  <a href="#a9a2c9aa3d5f85b4ea247130ddabbd490">More...</a><br/></td></tr>
<tr class="separator:a9a2c9aa3d5f85b4ea247130ddabbd490"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a161502b1f6e58ef0692186fdf0223c3d"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsszdd__decompressor.html#a161502b1f6e58ef0692186fdf0223c3d">extract</a> )(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, struct <a class="el" href="structmsszddd__header.html">msszddd_header</a> *szdd, const char *filename)</td></tr>
<tr class="memdesc:a161502b1f6e58ef0692186fdf0223c3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the compressed data from a SZDD file.  <a href="#a161502b1f6e58ef0692186fdf0223c3d">More...</a><br/></td></tr>
<tr class="separator:a161502b1f6e58ef0692186fdf0223c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1821c0005fd14f206688359c3be237f1"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsszdd__decompressor.html#a1821c0005fd14f206688359c3be237f1">decompress</a> )(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, const char *input, const char *output)</td></tr>
<tr class="memdesc:a1821c0005fd14f206688359c3be237f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decompresses an SZDD file to an output file in one step.  <a href="#a1821c0005fd14f206688359c3be237f1">More...</a><br/></td></tr>
<tr class="separator:a1821c0005fd14f206688359c3be237f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24b2cbdf6ad4745987e2162dffeaeaa7"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsszdd__decompressor.html#a24b2cbdf6ad4745987e2162dffeaeaa7">last_error</a> )(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self)</td></tr>
<tr class="memdesc:a24b2cbdf6ad4745987e2162dffeaeaa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the error code set by the most recently called method.  <a href="#a24b2cbdf6ad4745987e2162dffeaeaa7">More...</a><br/></td></tr>
<tr class="separator:a24b2cbdf6ad4745987e2162dffeaeaa7"><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 SZDD compressed 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#a81ec853a5fcfad25acdfab6bee1cd3cc" title="Creates a new SZDD decompressor. ">mspack_create_szdd_decompressor()</a>, <a class="el" href="mspack_8h.html#aaf070981f5d3a3a6bb430070cc2b3e73" title="Destroys an existing SZDD decompressor. ">mspack_destroy_szdd_decompressor()</a> </dd></dl>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a9a2c9aa3d5f85b4ea247130ddabbd490"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* msszdd_decompressor::close)(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, struct <a class="el" href="structmsszddd__header.html">msszddd_header</a> *szdd)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Closes a previously opened SZDD file. </p>
<p>This closes a SZDD file and frees the <a class="el" href="structmsszddd__header.html" title="A structure which represents an SZDD compressed file. ">msszddd_header</a> associated with it.</p>
<p>The SZDD header pointer is 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="structmsszdd__decompressor.html" title="A decompressor for SZDD compressed files. ">msszdd_decompressor</a> instance being called </td></tr>
    <tr><td class="paramname">szdd</td><td>the SZDD file to close </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structmsszdd__decompressor.html#afb164f3bff4752cc93c9cec90ffb42bc" title="Opens a SZDD file and reads the header. ">open()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a1821c0005fd14f206688359c3be237f1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* msszdd_decompressor::decompress)(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, const char *input, const char *output)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Decompresses an SZDD file to an output file in one step. </p>
<p>This opens an SZDD file as input, reads the header, then decompresses the compressed data immediately to an output file, finally closing both the input and output file. It is more convenient to use than <a class="el" href="structmsszdd__decompressor.html#afb164f3bff4752cc93c9cec90ffb42bc" title="Opens a SZDD file and reads the header. ">open()</a> then <a class="el" href="structmsszdd__decompressor.html#a161502b1f6e58ef0692186fdf0223c3d" title="Extracts the compressed data from a SZDD file. ">extract()</a> then <a class="el" href="structmsszdd__decompressor.html#a9a2c9aa3d5f85b4ea247130ddabbd490" title="Closes a previously opened SZDD file. ">close()</a>, if you do not need to know the SZDD output size or missing character.</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="structmsszdd__decompressor.html" title="A decompressor for SZDD compressed files. ">msszdd_decompressor</a> instance being called </td></tr>
    <tr><td class="paramname">input</td><td>the filename of the input SZDD file. This is passed directly to <a class="el" href="structmspack__system.html#a1a85cac5eeb55db6a432fe3824aa04a3" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a>. </td></tr>
    <tr><td class="paramname">output</td><td>the filename to write the decompressed data to. This is passed directly to <a class="el" href="structmspack__system.html#a1a85cac5eeb55db6a432fe3824aa04a3" 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>

</div>
</div>
<a class="anchor" id="a161502b1f6e58ef0692186fdf0223c3d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* msszdd_decompressor::extract)(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, struct <a class="el" href="structmsszddd__header.html">msszddd_header</a> *szdd, const char *filename)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Extracts the compressed data from a SZDD file. </p>
<p>This decompresses the compressed SZDD data stream and writes it to an output file.</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="structmsszdd__decompressor.html" title="A decompressor for SZDD compressed files. ">msszdd_decompressor</a> instance being called </td></tr>
    <tr><td class="paramname">szdd</td><td>the SZDD file to extract data from </td></tr>
    <tr><td class="paramname">filename</td><td>the filename to write the decompressed data to. This is passed directly to <a class="el" href="structmspack__system.html#a1a85cac5eeb55db6a432fe3824aa04a3" 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>

</div>
</div>
<a class="anchor" id="a24b2cbdf6ad4745987e2162dffeaeaa7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* msszdd_decompressor::last_error)(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_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="structmsszdd__decompressor.html#afb164f3bff4752cc93c9cec90ffb42bc" title="Opens a SZDD file and reads the header. ">open()</a> which does 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="structmsszdd__decompressor.html" title="A decompressor for SZDD compressed files. ">msszdd_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="structmsszdd__decompressor.html#afb164f3bff4752cc93c9cec90ffb42bc" title="Opens a SZDD file and reads the header. ">open()</a>, <a class="el" href="structmsszdd__decompressor.html#a161502b1f6e58ef0692186fdf0223c3d" title="Extracts the compressed data from a SZDD file. ">extract()</a>, <a class="el" href="structmsszdd__decompressor.html#a1821c0005fd14f206688359c3be237f1" title="Decompresses an SZDD file to an output file in one step. ">decompress()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="afb164f3bff4752cc93c9cec90ffb42bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structmsszddd__header.html">msszddd_header</a>*(* msszdd_decompressor::open)(struct <a class="el" href="structmsszdd__decompressor.html">msszdd_decompressor</a> *self, const char *filename)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Opens a SZDD file and reads the header. </p>
<p>If the file opened is a valid SZDD file, all headers will be read and a <a class="el" href="structmsszddd__header.html" title="A structure which represents an SZDD compressed file. ">msszddd_header</a> structure will be returned.</p>
<p>In the case of an error occuring, NULL is returned and the error code is available from <a class="el" href="structmsszdd__decompressor.html#a24b2cbdf6ad4745987e2162dffeaeaa7" 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="structmsszdd__decompressor.html#a9a2c9aa3d5f85b4ea247130ddabbd490" title="Closes a previously opened SZDD file. ">close()</a> is called on the SZDD file.</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="structmsszdd__decompressor.html" title="A decompressor for SZDD compressed files. ">msszdd_decompressor</a> instance being called </td></tr>
    <tr><td class="paramname">filename</td><td>the filename of the SZDD compressed file. This is passed directly to <a class="el" href="structmspack__system.html#a1a85cac5eeb55db6a432fe3824aa04a3" 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="structmsszddd__header.html" title="A structure which represents an SZDD compressed file. ">msszddd_header</a> structure, or NULL on failure </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="structmsszdd__decompressor.html#a9a2c9aa3d5f85b4ea247130ddabbd490" title="Closes a previously opened SZDD file. ">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.6
</small></address>
</body>
</html>