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>CXInitUncompContextRLFront</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXInitUncompContextRLFront</h1>
15
16<h2>Syntax</h2>
17<DL><DD><PRE class="construction">
18#include &lt;revolution/cx/CXStreamingUncompression.h&gt;
19
20void CXInitUncompContextRLFront( <A href="CXUncompContextRL.html">CXUncompContextRL</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 uncompression of RL-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.</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 the uncompression of RL-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="CXInitUncompContextRL.html"><CODE>CXInitUncompContextRL</CODE></A> function.
48</P>
49<P>
50When the <A href="CXReadUncompRL.html"><CODE>CXReadUncompRL</CODE></A> function is run using this context, the next set of data gets expanded in the region passed by the <SPAN class="argument">dest</SPAN> argument.
51</P>
52<P>
53If this context is going to be reused, it needs to be reinitialized after the expansion of each file is completed.
54</P>
55
56
57<h2>See Also</h2>
58<p class="reference">
59<A href="CXGetUncompressedSize.html">CXGetUncompressedSize</A>,
60<A href="CXUncompressRL.html">CXUncompressRL</A>,
61<A href="CXSecureUncompressRL.html">CXSecureUncompressRL</A>,
62<A href="CXInitUncompContextRL.html">CXInitUncompContextRL</A>,
63<A href="CXReadUncompRL.html">CXReadUncompRL</A>,
64<A href="CXIsFinishedUncompRL.html">CXIsFinishedUncompRL</A>,
65<A href="CXUncompContextRL.html">CXUncompContextRL</A>,
66<A href="CXCompressRL.html">CXCompressRL</A>,
67<A href="../tools/ntcompress.html">ntcompress</A>
68</p>
69
70<H2>Revision History</H2>
71<P>
722007/09/03 Corrected an error in <B>See Also</B>.<BR>2007/06/05 Initial version.<BR>
73</P>
74
75<hr><p>CONFIDENTIAL</p></body>
76</html>
77