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;
14s32 Read(
15     void * buf,
16     size_t size,
17     bit32 attr = ATTRIBUTE_NONE
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>out</td>
33<th>buf</th>
34<td>Buffer where the received data is stored.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>size</th>
39<td>Maximum size of the data to receive.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>attr</th>
44<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.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the actual number of bytes that were received. If an error occurred, returns <CODE>-1</CODE>. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Receives data from the host and returns the size of data received.</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 /> Returns the actual number of bytes that were received.</p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/06/14</dt>
56<dd>Added description of arguments and behavior.<br />
57        </dd>
58        <dt>2010/03/31</dt>
59<dd>Initial version.<br />
60        </dd>
61      </dl>
62    </div>
63  <hr><p>CONFIDENTIAL</p></body>
64</html>
65