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>ReadData</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::NsData::ReadData</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14s32 ReadData(
15u8 * pDataBuf,
16size_t bufLen
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>out</td>
32<th>pDataBuf</th>
33<td>Specifies the NS data buffer.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>bufLen</th>
38<td>Specifies the NS data buffer length.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the size in bytes of the read data. Returns <CODE>0</CODE> if it reached the end of the data. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>NN_BOSS_NSDATA_READ_ERROR_GET_HEADER</CODE></th>
52<td>Failed to get NS data header.</td>
53        </tr>
54        <tr>
55<th><CODE>NN_BOSS_NSDATA_READ_ERROR_READ_DATA</CODE></th>
56<td>Failed to load NS data.</td>
57        </tr>
58        <tr>
59<th><CODE>NN_BOSS_NSDATA_READ_ERROR_IPC</CODE></th>
60<td>Internal error has occurred.</td>
61        </tr>
62      </table> </div>
63<h2>Description</h2>
64    <div class="section">
65<p>Reads an NS data file. The interface resembles the file access interface. After allocating an adequately sized buffer, call this function multiple times to read an entire NS data file. Returns <CODE>0</CODE> upon reaching end of file, indicating that the read is finished. The application only reads one set of NS data at any one time, but even when a large NSD is being read, other applications are not blocked from reading NS data, provided the same set of NS data is not being accessed. Note that an error will be returned if the target NS data cannot be found, be it because another application has already deleted the NS data, there was not enough space available when downloading the NSA, or because the data have been automatically deleted.</p><!-- write here --></div>
66<h2>Revision History</h2>
67    <div class="section">
68      <dl class="history">
69        <dt>2010/09/16</dt>
70<dd>Initial version.<br />
71        </dd>
72      </dl>
73    </div>
74  <hr><p>CONFIDENTIAL</p></body>
75</html>