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 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::boss::NsaList</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/boss/Overview.html">boss</a>::NsaList</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56<pre class="definition">class NsaList</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>A class that handles all processing related to NSA lists. By specifying a file path for the NSA list, you can do things like download the NSA list to that path or parse the NSA list given by that path.</p><p>An NSA list is a collection of data (NSA items) that can be obtained by an NADL task. By getting this list, an application can allow users to choose which data to download. (For example, consider an NADL task that downloads items. If it gets an NSA list in advance, it can then tell the user which items are available and only download the ones that the user wants.<br /></p><p>NSA lists have the following basic workflow.<br /><br />1. Download an NSA list (<a href="../../../nn/boss/NsaList/Download.html"><CODE>NsaList::Download</CODE></a>) <br /> 2. Verify the NSA list (<a href="../../../nn/boss/NsaList/CheckValidity.html"><CODE>NsaList::CheckValidity</CODE></a>) <br /> 3. Parse the NSA list (<a href="../../../nn/boss/NsaList/Parse.html"><CODE>NsaList::Parse</CODE></a>)</p><p>After parsing a list, you can get a variety of NSA information with the <a href="../../../nn/boss/NsaList/NsaInformation/Overview.html"><CODE>NsaInformation</CODE></a> type. Using the <a href="../../../nn/boss/NsaList/NsaInformation/Overview.html"><CODE>NsaInformation</CODE></a> element's <CODE>fileName</CODE> value, you can construct a URL for an NADL task to download. (A download URL for an NADL task has the following composition. The value of <CODE>fileName</CODE> corresponds to <I>[Filename]</I> below. <I>[BOSS Code]</I> is a random string assigned to your application when you apply to use NADL tasks. <I>[Task ID]</I> is the relevant task ID. In other words, an application can establish a URL once <I>[Filename]</I> has been determined.<br /><br /><CODE><ulink url="https://npdl.cdn.nintendowifi.net/p01/nsa/">https://npdl.cdn.nintendowifi.net/p01/nsa/</ulink><I>[BOSS Code]</I>/<I>[Task ID]</I>/<I>[Filename]</I></CODE></p><!-- write here --></div> 61 <a name="struct" id="struct"> 62<h2>Structures</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <th> 67<a href="../../../nn/boss/NsaList/NsaInformation/Overview.html"><CODE>nn::boss::NsaList::NsaInformation</CODE></a> 68 </th> 69<td>A structure that stores all the NSA data in a parsed NSA list.</td> 70 </tr> 71 <tr> 72 <th> 73<a href="../../../nn/boss/NsaList/SearchAttributes/Overview.html"><CODE>nn::boss::NsaList::SearchAttributes</CODE></a> 74 </th> 75<td>Search elements used to specify which NSA to include in an NSA list when you download it (when you call the <a href="../../../nn/boss/NsaList/Download.html"><CODE>NsaList::Download</CODE></a> function).</td> 76 </tr> </table> 77 </div> 78 </a> <a name="enum" id="enum"> 79<h2>Enumerated Types</h2> 80 <div class="section"> 81 <table class="members"> 82 <tr> 83 <td width="100"> </td> 84 <th> 85<a href="../../../nn/boss/NsaList/ParseResult.html"><CODE>ParseResult</CODE></a> 86 </th> 87<td>Definitions of <a href="../../../nn/boss/NsaList/Parse.html"><CODE>NsaList::Parse</CODE></a> results.</td> 88 </tr> </table> 89 </div> 90 </a> <a name="constant" id="constant"> 91<h2>Member Constants</h2> 92 <div class="section"> 93 <table class="members"> 94 <tr> 95 <td width="100"> 96<span class="static_style" title="static">S</span> 97 </td> 98 <th> 99<span class="argument"><a href="../../../nn/boss/NsaList/NN_BOSS_NSALIST_WAIT_FINISH_TIMEOUT_DEFAULT_SEC.html"><CODE>NN_BOSS_NSALIST_WAIT_FINISH_TIMEOUT_DEFAULT_SEC</CODE></a></span> 100 </th> 101<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 102<td>Default value definition for the timeout (in sec) used by <a href="../../../nn/boss/NsaList/Download.html"><CODE>Download()</CODE></a>.</td> 103 </tr> 104 <tr> 105 <td width="100"> 106<span class="static_style" title="static">S</span> 107 </td> 108 <th> 109<span class="argument"><a href="../../../nn/boss/NsaList/NN_BOSS_NSALIST_MAX_SIZE.html"><CODE>NN_BOSS_NSALIST_MAX_SIZE</CODE></a></span> 110 </th> 111<td width="100">const <a href="../../../nn_types/s64.html">s64</a></td> 112<td>A definition of the maximum file size for the NSA list downloaded by the <a href="../../../nn/boss/NsaList/Download.html"><CODE>Download</CODE></a> function.</td> 113 </tr> </table> 114 </div> 115 </a> <a name="function" id="function"> 116<h2>Member Functions</h2> 117 <div class="section"> 118 <table class="members"> 119 <tr> 120 <td width="100"> </td> 121 <th> 122<a href="../../../nn/boss/NsaList/NsaList.html"><CODE>NsaList</CODE></a> 123 </th> 124<td>Constructor.</td> 125 </tr> 126 <tr> 127<td width="100"> <span class="virtual_style" title="virtual">V</span> 128 </td> 129 <th> 130<a href="../../../nn/boss/NsaList/~NsaList.html"><CODE>~NsaList</CODE></a> 131 </th> 132<td>Destructor.</td> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137<a href="../../../nn/boss/NsaList/Download.html"><CODE>Download</CODE></a> 138 </th> 139<td>Downloads the NSA list.</td> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144<a href="../../../nn/boss/NsaList/Cancel.html"><CODE>Cancel</CODE></a> 145 </th> 146<td>Cancels download of the NSA list.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151<a href="../../../nn/boss/NsaList/GetHttpStatusCode.html"><CODE>GetHttpStatusCode</CODE></a> 152 </th> 153<td>Gets the HTTP status code received when an NSA list is downloaded.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158<a href="../../../nn/boss/NsaList/GetResult.html"><CODE>GetResult</CODE></a> 159 </th> 160<td>Gets the result code for an NSA list download.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165<a href="../../../nn/boss/NsaList/Parse.html"><CODE>Parse</CODE></a> 166 </th> 167<td>Parses the NSA list and stores each NSA information found in an array.</td> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172<a href="../../../nn/boss/NsaList/GetDigest.html"><CODE>GetDigest</CODE></a> 173 </th> 174<td>Gets the digest value included in an NSA list.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179<a href="../../../nn/boss/NsaList/CheckValidity.html"><CODE>CheckValidity</CODE></a> 180 </th> 181<td>Checks the validity of an NSA list. (This confirms that the digest value included in the list matches the digest value calculated from the data in the list.)</td> 182 </tr> </table> 183 </div> 184 </a> 185<h2>Revision History</h2> 186 <div class="section"> 187 <dl class="history"> 188 <dt>2011/10/27</dt> 189<dd>Initial version.<br /> 190 </dd> 191 </dl> 192 </div> 193 <hr><p>CONFIDENTIAL</p></body> 194</html>