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>nn::hio::CTR::SerialChannel::Read</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/hio.h&gt;
14
15s32 Read(
16     void * buf,
17     size_t size,
18     bit32 attr = ATTRIBUTE_NONE
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>out</td>
34          <th>buf</th>
35          <td>Buffer where the received data is stored.</td>
36        </tr>
37        <tr>
38          <td>in</td>
39          <th>size</th>
40          <td>Maximum size of the data to receive.</td>
41        </tr>
42        <tr>
43          <td>in</td>
44          <th>attr</th>
45          <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>
46        </tr> </table>
47    </div>
48    <h2>Return Values</h2>
49    <div class="section">Returns the actual number of bytes that were received. If an error occurred, returns <CODE>-1</CODE>. </div>
50    <h2>Description</h2>
51    <div class="section">
52      <p>Receives data from the host.</p><!-- write here --></div>
53    <h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2010/03/31</dt>
57        <dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>