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>CXSecureUncompressRL</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXSecureUncompressRL</h1>
15<h2>C Specification</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;revolution/cx.h&gt;</CODE><BR> <BR> <CODE>s32 CXSecureUncompressRL( const void *srcp, u32 srcSize, void *destp );</CODE></dd>
20</dl>
21<h2>Arguments</h2>
22<TABLE border="1" width="100%">
23  <TBODY>
24    <TR>
25<TD width="13%"><EM><STRONG>srcp</STRONG></EM></TD>
26<TD width="87%">The source address where run length compressed data is stored.</TD>
27    </TR>
28    <TR>
29<TD width="13%"><EM><STRONG>srcSize</STRONG></EM></TD>
30<TD width="87%">Source data size</TD>
31    </TR>
32    <TR>
33<TD width="13%"><EM><STRONG>destp</STRONG></EM></TD>
34<TD width="87%">Destination address for decompression.</TD>
35    </TR>
36  </TBODY>
37</TABLE>
38
39<h2>Return Values</h2>
40<TABLE border="1" width="100%">
41  <TBODY>
42    <TR>
43<TD width="13%"><EM><STRONG>CX_ERR_SUCCESS</STRONG></EM></TD>
44<TD width="87%">Function completes successfully.</TD>
45    </TR>
46    <TR>
47<TD width="13%"><EM><STRONG>CX_ERR_UNSUPPORTED</STRONG></EM></TD>
48<TD width="87%">Unsupported compression data type</TD>
49    </TR>
50    <TR>
51<TD width="13%"><EM><STRONG>CX_ERR_SRC_SHORTAGE</STRONG></EM></TD>
52<TD width="87%">The source data size is too small</TD>
53    </TR>
54    <TR>
55<TD width="13%"><EM><STRONG>CX_ERR_SRC_REMAINDER</STRONG></EM></TD>
56<TD width="87%">The source data size is too large</TD>
57    </TR>
58    <TR>
59<TD width="13%"><EM><STRONG>CX_ERR_DEST_OVERRUN</STRONG></EM></TD>
60<TD width="87%">Buffer overrun for the destination for the extraction  (buffer overrun)</TD>
61    </TR>
62  </TBODY>
63</TABLE>
64
65<H2>Description</H2>
66<P>This function decompresses run length compressed data and writes the data to the specified region of memory. The source address must be aligned to a 4-byte boundary.</P>
67
68<P>
69To perform streaming uncompression of data, use the <A href="CXReadUncompRL.html">CXReadUncompRL</A> function.
70</P>
71
72<h2>See Also</h2>
73<p><CODE><A href="CXGetUncompressedSize.html">CXGetUncompressedSize</A>, <A href="CXUncompressRL.html">CXUncompressRL</A>, <A href="CXInitUncompContextRL.html">CXInitUncompContextRL</A>, <A href="CXReadUncompRL.html">CXReadUncompRL</A>, <A href="CXIsFinishedUncompRL.html">CXIsFinishedUncompRL</A>, <A href="CXCompressRL.html">CXCompressRL</A>, <A href="../tools/ntcompress.html">ntrompress</A></CODE></p>
74
75<H2>Revision History</H2>
76<P>2007/05/24 Initial version.</P>
77</body>
78</html>
79