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><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/boss/Overview.html">boss</a>::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 <a href="../../nn_types/u32.html">u32</a> dataType, 16 <a href="../../nn/boss/NsDataIdList/Overview.html">NsDataIdList</a> * pNsDataId 17); 18</pre> 19 </div> 20<h2>Parameters</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. (However, data for Notifications that the application cannot obtain will be excluded.)</td> 34 </tr> 35 <tr> 36<td>out</td> 37<th>pNsDataId</th> 38<td>Specifies an object storing a list of NS 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 /> <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>Result::IsSuccess</CODE></th> 52<td>Retrieval successful.</td> 53 </tr> 54 <tr> 55<th><CODE>ResultNsDataListSizeShortage</CODE></th> 56<td>Because the size of <a href="../../nn/boss/NsDataIdList/Overview.html">NsDataIdList</a> was insufficient, not all NS data serial IDs could be stored.<br />Continue and call repeatedly until all NS data serial IDs are obtained.</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>The BOSS storage corresponding to the appropriate application ID is not registered. Please check if the BOSS storage is registered.</td> 69 </tr> 70 <tr> 71<th><CODE>ResultIpcNotSessionInitialized</CODE></th> 72<td>The session has not been initialized.<BR>This <CODE><a href="../../nn/Result/Overview.html">Result</a></CODE> is returned if this function is called before the <CODE><a href="../../nn/boss/Initialize.html">Initialize</A></CODE> function. Always call the <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> function first when using 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 data from the expanded save data region where the BOSS storage is registered. <br />The NS data ID are stored in descending order from the start of the list.</p><p>The new arrival flag is cleared if this function is used to get all lists.<br />The return value is <CODE>ER_NSDATA_LIST_SIZE_SHORTAGE</CODE> if the entire list could not be obtained.<br />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 the <CODE><a href="../../nn/boss/NsDataIdList/Overview.html">NsDataIdList</a></CODE> class.</p><p> </p><p>[How to use the <SPAN class="argument">dataType</SPAN> argument]</p><p>Specify <CODE>DATA_TYPE_ALL</CODE> to search all NS data. In other cases, specify search targets using a bitwise OR of global data types and private data types.<br />Only serial 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.</p><p>There are three global data types, as follows.</p><p><CODE>nn::boss::DATA_TYPE_APPDATA</CODE>: Added data<br /><CODE>nn::boss::DATA_TYPE_NEWS</CODE>: Data displayed in notifications (cannot be obtained by the application)<br /><CODE>nn::boss::DATA_TYPE_EXBANNER DL</CODE>: Contextual banner data<br /></p><p>Private data types are 16-bit values. They are treated as masks for the private data types of NS data (lower 16 bits of the data type). If any of the bits set in the specified private data type are set in the private data type of the NS data<br />(that is, 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 retrieve added data according to the ways they have been proprietarily categorized.<br /></p><!-- write here --></div> 82<h2>Revision History</h2> 83 <div class="section"> 84 <dl class="history"> 85 <dt>2012/04/26</dt> 86<dd>Added note that the new arrival flag is cleared if this operation is used to get all lists.<br /> 87 </dd> 88 <dt>2010/09/16</dt> 89<dd>Initial version.<br /> 90 </dd> 91 </dl> 92 </div> 93 <hr><p>CONFIDENTIAL</p></body> 94</html>