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>Read</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/hio/Overview.html">hio</a>::<a href="../../../../nn/hio/CTR/Overview.html">CTR</a>::<a href="../../../../nn/hio/CTR/SerialChannel/Overview.html">SerialChannel</a>::Read</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/hio.h&gt;
14
15<a href="../../../../nn/Result/Overview.html">Result</a> Read(
16     size_t * pReadSize,
17     void * buf,
18     size_t size,
19     <a href="../../../../nn_types/bit32.html">bit32</a> attr = ATTRIBUTE_NONE
20);
21</pre>
22    </div>
23<h2>Parameters</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>out</td>
35<th>pReadSize</th>
36<td>Location where the size of data (in bytes) that were actually received are stored.</td>
37        </tr>
38        <tr>
39<td>out</td>
40<th>buf</th>
41<td>Buffer where the received data is stored.</td>
42        </tr>
43        <tr>
44<td>in</td>
45<th>size</th>
46<td>Maximum size of the data to receive.</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th>attr</th>
51<td>Reception attribute.<br />If set to <CODE>ATTRIBUTE_NONE</CODE>, the function blocks until either <SPAN class="argument">size</SPAN> bytes can be received or the channel is closed.<br />If set to <CODE>ATTRIBUTE_NO_WAIT</CODE>, the function returns as soon as there is no more data to receive. If <SPAN class="argument">size</SPAN> is larger than the amount of received data, the function returns without receiving data.</td>
52        </tr> </table>
53    </div>
54<h2>Return Values</h2>
55<div class="section">Returns the result of the operation. </div>
56<h2>Description</h2>
57    <div class="section">
58<p>Receives data from the host and returns the result of the operation.</p><p><B>size</B> bytes of data are received to the buffer specified by <B>buf</B>.<br />The <B>attr</B> parameter specifies how to behave when the received data is fewer bytes than specified by <B>size</B>. <br />The process returns a <CODE><a href="../../../../nn/Result/Overview.html">nn::Result</a></CODE>-type result.</p><!-- write here --></div>
59<h2>Revision History</h2>
60    <div class="section">
61      <dl class="history">
62        <dt>2010/06/14</dt>
63<dd>Added description of arguments and behavior.<br />
64        </dd>
65        <dt>2010/03/31</dt>
66<dd>Initial version.<br />
67        </dd>
68      </dl>
69    </div>
70  <hr><p>CONFIDENTIAL</p></body>
71</html>