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">#include &lt;nn/cx.h&gt;
14
15<a href="../../nn_types/u32.html">u32</a> CompressRL(
16     const <a href="../../nn_types/u8.html">u8</a> * srcp,
17     <a href="../../nn_types/u32.html">u32</a> size,
18     <a href="../../nn_types/u8.html">u8</a> * dstp
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th><CODE>srcp</CODE></th>
35<td>Pointer to compression source data.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th><CODE>size</CODE></th>
40<td>Compression source data size.</td>
41        </tr>
42        <tr>
43<td>out</td>
44<th><CODE>dstp</CODE></th>
45<td>Pointer to compression target data (requires a buffer larger than the compression source data).</td>
46        </tr> </table>
47    </div>
48<h2>Return Values</h2>
49<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>
50<h2>Description</h2>
51    <div class="section">
52<p>Carries out run-length compression.</p><p>
53Argument values must adhere to the following restrictions:
54        <ul><li>
55The value of <SPAN class="argument">size</SPAN> must be larger than 4.
56          </li></ul></p></div>
57<h2>Revision History</h2>
58    <div class="section">
59      <dl class="history">
60        <dt>2011/04/06</dt>
61<dd>Added text about the restriction on argument values.<br />
62        </dd>
63        <dt>2010/11/10</dt>
64<dd>	Initial version.<br />
65        </dd>
66      </dl>
67    </div>
68  <hr><p>CONFIDENTIAL</p></body>
69</html>