1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../css/manpage.css" type="text/css" />
7<title>CompressRL</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/cx/Overview.html">cx</a>::CompressRL</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14u32 CompressRL(
15     const u8 * srcp,
16     u32             size,
17     u8 * dstp
18);
19</pre>
20    </div>
21<h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>in</td>
33<th>srcp</th>
34<td>Pointer to compression source data.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>size</th>
39<td>Compression source data size.</td>
40        </tr>
41        <tr>
42<td>out</td>
43<th>dstp</th>
44<td>Pointer to compression target data (requires a buffer larger than the compression source data).</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the size of the compressed data. If the compressed data is larger than the original data, compression is terminated and <CODE>0</CODE> is returned. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Carries out run-length compression.</p><p>
52Argument values must adhere to the following restrictions:
53        <ul><li>
54The value of <B>size </B>must be larger than 4.
55          </li></ul></p></div>
56<h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2011/04/06</dt>
60<dd>Added text about the restriction on argument values.<br />
61        </dd>
62        <dt>2010/11/10</dt>
63<dd>	Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>
69