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>CXCompressRL</title>
9<LINK rel="stylesheet" href="../CSS/revolution.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">CXCompressRL</h1>
15
16<h2>Syntax</h2>
17<DL><DD><PRE class="construction">
18#include &lt;revolution/cx.h&gt;
19
20u32 CXCompressRL( const u8 *srcp, u32 size, u8 *dstp );
21</PRE></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1">
25  <TBODY>
26    <TR>
27<TH>srcp</TH>
28<TD>The source address where the data to compress is stored.</TD>
29    </TR>
30    <TR>
31<TH>size</TH>
32<TD>The data size of the source to compress.</TD>
33    </TR>
34    <TR>
35<TH>dstp</TH>
36<TD>Needs a pointer to the compression destination buffer and a region greater than the source data size. Requires 4-byte alignment.</TD>
37    </TR>
38  </TBODY>
39</TABLE>
40
41<h2>Return Values</h2>
42<p>Returns the size of the compressed data. If the data after compression is larger than the source file, no compression will be performed and a zero will be returned.</p>
43
44<H2>Description</H2>
45<P>Performs RL-compression on the data, then writes it to a specified memory region. A region of the same size as the source data must be prepared in the compression destination buffer.</P>
46
47<h2>See Also</h2>
48<p class="reference">
49<A href="CXGetUncompressedSize.html">CXGetUncompressedSize</A>,
50<A href="CXUncompressRL.html">CXUncompressRL</A>,
51<A href="CXSecureUncompressRL.html">CXSecureUncompressRL</A>,
52<A href="CXInitUncompContextRL.html">CXInitUncompContextRL</A>,
53<A href="CXReadUncompRL.html">CXReadUncompRL</A>,
54<A href="CXIsFinishedUncompRL.html">CXIsFinishedUncompRL</A>,
55<A href="../tools/ntcompress.html">ntcompress</A>
56</p>
57
58<H2>Revision History</H2>
59<P>
602007/09/03 Corrected error in the See Also section.<BR>2006/07/06 Initial version.<BR>
61</P>
62
63<hr><p>CONFIDENTIAL</p></body>
64</html>
65