1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>CXInitUncompContextHuffmanFront</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXInitUncompContextHuffmanFront</h1>
15
16<h2>Syntax</h2>
17<DL><DD><PRE class="construction">
18#include &lt;revolution/cx/CXStreamingUncompression.h&gt;
19
20void CXInitUncompContextHuffmanFront( <A href="CXUncompContextHuffman.html">CXUncompContextHuffman</A> *context,
21                                      void*                   dest,
22                                      s32                     destSize );
23</PRE></dd></dl>
24
25<h2>Arguments</h2>
26<TABLE class="arguments" border="1">
27  <TBODY>
28    <TR>
29      <TH>context</TH>
30      <TD>Pointer to the context structure to be used for streaming the uncompression of Huffman-compressed data.</TD>
31    </TR>
32    <TR>
33      <TH>dest</TH>
34      <TD>Destination buffer for uncompressed data.</TD>
35    </TR>
36    <TR>
37      <TH>destSize</TH>
38      <TD>Maximum amount of data that will be uncompressed. Specify a multiple of 4 bytes.</TD>
39    </TR>
40  </TBODY>
41</TABLE>
42
43<h2>Return Values</h2>
44<p>None.</p>
45
46<H2>Description</H2>
47<P>Initializes the context structure for streaming uncompression of Huffman-compressed data. Use this interface for uncompressing only the number of bytes of data specified by <SPAN class="argument">destSize</SPAN>.<BR>To uncompress all data, use the <A href="CXInitUncompContextHuffman.html"><CODE>CXInitUncompContextHuffman</CODE></A> function.
48</P>
49
50<P>
51When the <A href="CXReadUncompHuffman.html"><CODE>CXReadUncompHuffman</CODE></A> function is run in this context, the next set of data gets expanded in the region passed by the <SPAN class="argument">dest</SPAN> argument.
52</P>
53<P>
54If this context is going to be reused, it needs to be reinitialized after the expansion of each file is completed.
55</P>
56
57<h2>See Also</h2>
58<p class="reference">
59<A href="CXGetUncompressedSize.html"><CODE>CXGetUncompressedSize</CODE></A><BR><A href="CXUncompressHuffman.html"><CODE>CXUncompressHuffman</CODE></A><BR><A href="CXSecureUncompressHuffman.html"><CODE>CXSecureUncompressHuffman</CODE></A><BR><A href="CXInitUncompContextHuffman.html"><CODE>CXInitUncompContextHuffman</CODE></A><BR><A href="CXReadUncompHuffman.html"><CODE>CXReadUncompHuffman</CODE></A><BR><A href="CXIsFinishedUncompHuffman.html"><CODE>CXIsFinishedUncompHuffman</CODE></A><BR><A href="CXCompressHuffman.html"><CODE>CXCompressHuffman</CODE></A><BR><A href="../tools/ntcompress.html"><CODE>ntcompress</CODE></A>
60</p>
61
62<H2>Revision History</H2>
63<P>
642008/09/25 Added the restriction that <CODE>destSize</CODE> be a multiple of 4 bytes.<BR>2007/09/03 Corrected an error in <B>See Also</B>.<BR>2007/06/05 Initial version.<BR>
65</P>
66
67<hr><p>CONFIDENTIAL</p></body>
68</html>
69