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 function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></A> values listed below. <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>ResultSuccess</CODE></th>
64<td>Process was successful.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultNotInitialized</CODE></th>
68<td>The library is not initialized.</td>
69        </tr>
70      </table> </div>
71<h2>Description</h2>
72    <div class="section">
73<p>Reads data from a DSP pipe.</p>
74      </div>
75<h2>Revision History</h2>
76    <div class="section">
77      <dl class="history">
78        <dt>2010/02/02</dt>
79<dd>Initial version.<br />
80        </dd>
81      </dl>
82    </div>
83  <hr><p>CONFIDENTIAL</p></body>
84</html>