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>ReadPipeIfPossible</title>
8  </head>
9  <body>
10<h1><CODE>nn::dsp::CTR::ReadPipeIfPossible</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> ReadPipeIfPossible(
15     int port,
16     void * buffer,
17     u16 length,
18     u16 * pLengthRead
19);
20</pre>
21    </div>
22<h2>Arguments</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>port</th>
35<td>Port number.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>buffer</th>
40<td>Address of the buffer into which to load data.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>length</th>
45<td>Length of the data to load.</td>
46        </tr>
47        <tr>
48<td>out</td>
49<th>pLengthRead</th>
50<td>Location at which to store the length of data that was actually loaded.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the result of the operation. </div>
55<h2>Description</h2>
56    <div class="section">
57<p>Reads data from a DSP pipe.</p><p>
58The return value details are as follows.
59</p><p><table><tr><th>Level</th><th>Summary</th><th>Module</th><th>Description</th><th>Content</th></tr><tr><td>LEVEL_SUCCESS</td><td>SUMMARY_SUCCESS</td><td>MODULE_COMMON</td><td>DESCRIPTION_SUCCESS</td><td>Process succeeded.</td></tr><tr><td>LEVEL_STATUS</td><td>SUMMARY_INVALID_STATE</td><td>MODULE_NN_DSP</td><td>DESCRIPTION_NOT_INITIALIZED</td><td>The DSP library is not initialized.</td></tr></table></p></div>
60<h2>Revision History</h2>
61    <div class="section">
62      <dl class="history">
63        <dt>2010/02/02</dt>
64<dd>Initial version.<br />
65        </dd>
66      </dl>
67    </div>
68  <hr><p>CONFIDENTIAL</p></body>
69</html>