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>CXReadUncompRL</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXReadUncompRL</h1>
15<h2>C Specification</h2>
16
17<dl>
18  <dd>
19<PRE><CODE>#include &lt;revolution/cx/CXStreamingUncompression.h&gt;</CODE><BR>
20  <BR>
21<CODE>s32 CXReadUncompRL( <A href="CXUncompContextRL.html">CXUncompContextRL</A> *context,
22const void*       data,
23u32               len );</CODE></PRE>
24  </dd>
25</dl>
26<h2>Arguments</h2>
27<TABLE border="1" width="100%">
28  <TBODY>
29    <TR>
30<TD width="13%"><EM><STRONG>context</STRONG></EM></TD>
31<TD width="87%">Pointer to the context structure for uncompression of RL-compressed data.</TD>
32    </TR>
33    <TR>
34<TD width="13%"><EM><STRONG>data</STRONG></EM></TD>
35<TD width="87%">Pointer to the next data in the file being decompressed.</TD>
36    </TR>
37    <TR>
38<TD><EM><STRONG>len</STRONG></EM></TD>
39<TD>Size of the data provided in the second argument.</TD>
40    </TR>
41  </TBODY>
42</TABLE>
43
44<h2>Return Values</h2>
45<p>Returns the number of remaining bytes of data being uncompressed. If all of the data is finished being uncompressed, the function returns <code>0</code>.</p>
46
47<H2>Description</H2>
48<P>Performs streaming uncompression of running length-compressed data, doing just the data size given, and copies it to the buffer specified by the <BR> <A href="CXInitUncompContextRL.html">CXInitUncompContextRL</A> function.<BR>This function is slow compared to the <A href="CXUncompressRL.html">CXUncompressRL</A> function, which decompresses all of the data at once.</P>
49
50<h2>See Also</h2>
51<p><CODE><A href="CXUncompressRL.html">CXUncompressRL</A>, <A href="CXInitUncompContextRL.html">CXInitUncompContextRL</A>, <A href="CXUncompContextRL.html">CXUncompContextRL</A>,<A href="CXReadUncompLZ.html">CXReadUncompLZ</A>, <A href="CXReadUncompHuffman.html">CXReadUncompHuffman</A>, <A href="CXCompressRL.html">CXCompressRL</A>, <A href="CXIsFinishedUncompRL.html">CXIsFinishedUncompRL</A><br></CODE></p>
52
53<H2>Revision History</H2>
54<P>07/06/2006 Initial version.</P>
55<hr>
56<P>CONFIDENTIAL</p>
57</BODY>
58</HTML>
59