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>GetNsDataIdList</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::GetNsDataIdList</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> GetNsDataIdList(
15     u32 dataType,
16     <a href="../../nn/boss/NsDataIdList/Overview.html">NsDataIdList</a> * pNsDataId
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>in</td>
32<th>dataType</th>
33<td>Specifies the data type. (Use <CODE>DATA_TYPE_ALL</CODE> to specify all data types. Note that this excludes the data type for Notifications because this data cannot be obtained from the application.)</td>
34        </tr>
35        <tr>
36<td>out</td>
37<th>pNsDataId</th>
38<td>Specifies an object storing a list of content data.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<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 />
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>ResultSuccess</CODE></th>
52<td>Retrieval successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultNsDataListSizeShortage</CODE></th>
56<td>Size of <CODE>NsDataIdList</CODE> is insufficient (could not store all the NSD serial IDs). Continue calling repeatedly until you get all the NSD serial IDs.</td>
57        </tr>
58        <tr>
59<th><CODE>ResultNsDataListUpdated</CODE></th>
60<td>The target NSD group for BOSS storage was updated since the last time a list was obtained.</td>
61        </tr>
62        <tr>
63<th><CODE>ResultInvalidNsDataIdList</CODE></th>
64<td>The pointer to NS data list information is <CODE>NULL</CODE>.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultStorageNotFound</CODE></th>
68<td>Storage has not been registered for the corresponding application ID. Confirm whether any storage has been registered yet.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
72<td>The session has not been initialized. This result is returned if this function is called before the <CODE><a href="../../nn/boss/Initialize.html">Initialize</A></CODE> function. Always call the <CODE><a href="../../nn/boss/Initialize.html">Initialize</a></CODE> function first thing when you use the BOSS library. </td>
73        </tr>
74        <tr>
75<th>A value other than the above.</th>
76<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
77        </tr>
78      </table> </div>
79<h2>Description</h2>
80    <div class="section">
81<p>Specifies the data type and gets a list of NS content from the registered storage expanded save region.</p><p>The return value is <CODE>ER_NSDATA_LIST_SIZE_SHORTAGE</CODE> if the entire list could not be obtained. If you call this function more than once and it detects an update in the list's content, such as a new download, it returns <CODE>ER_NSDATA_LIST_UPDATED</CODE> and you must start over. In this case, re-call this function after initializing the instance of <a href="../../nn/boss/NsDataIdList/Overview.html"><CODE>NsDataIdList</CODE></A>.</p><p>Use of <SPAN class="argument">dataType</SPAN> parameter:<br />Specify <CODE>DATA_TYPE_ALL</CODE> to search all NS data.<br />In other cases, specify search targets using a bitwise OR of global data types and private data types.<br />Only IDs of NS data whose global data types match and whose private data types match the mask and are determined to be acquisition targets are stored in the list.<br /><br />There are three global data types, as follows.<br /><CODE>nn::boss::DATA_TYPE_APPDATA</CODE>: Additional data<br /> <CODE>nn::boss::DATA_TYPE_NEWS</CODE>: Data displayed in notifications (cannot be obtained by applications)<br /> <CODE>nn::boss::DATA_TYPE_EXBANNER DL</CODE>: Contextual banner data<br /><br />The private data type is a 16-bit value, which is treated as a mask value for the private data type of the NS data (lower-order 16 bits of data type).<br />If any of the bits set in the specified private data type are set in the private data type of the NS data<br />(i.e., if the bitwise AND of the private data types is non-zero), then that NS data item can be retrieved.<br />For example, to get all added data, specify <CODE>DATA_TYPE_APPDATA | 0x0000FFFF</CODE> as <SPAN class="argument">dataType</SPAN>.<br />Applications can use the data types of NS data to categorize added data proprietarily.<br /></p><!-- write here --></div>
82<h2>Revision History</h2>
83    <div class="section">
84      <dl class="history">
85        <dt>2010/09/16</dt>
86<dd>Initial version.<br />
87        </dd>
88      </dl>
89    </div>
90  <hr><p>CONFIDENTIAL</p></body>
91</html>
92