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>Download</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/boss/Overview.html">boss</a>::<a href="../../../nn/boss/NsaList/Overview.html">NsaList</a>::Download</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> Download(
15     const char * bossCode,
16     const char * taskId,
17     const <a href="../../../nn/boss/NsaList/SearchAttributes/Overview.html">SearchAttributes</a> * attributes = NULL,
18     <a href="../../../nn_types/u32.html">u32</a> waitTimeoutSec = <a href="../../../nn/boss/NsaList/NN_BOSS_NSALIST_WAIT_FINISH_TIMEOUT_DEFAULT_SEC.html">NN_BOSS_NSALIST_WAIT_FINISH_TIMEOUT_DEFAULT_SEC</a>,
19     <a href="../../../nn_types/s64.html">s64</a> fileSize = <a href="../../../nn/boss/NsaList/NN_BOSS_NSALIST_MAX_SIZE.html">NN_BOSS_NSALIST_MAX_SIZE</a>
20);
21</pre>
22    </div>
23<h2>Parameters</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th><CODE>bossCode</CODE></th>
36<td>BOSS code of the target task.</td>
37        </tr>
38        <tr>
39<td>in</td>
40<th><CODE>taskId</CODE></th>
41<td>Task ID of the target task.</td>
42        </tr>
43        <tr>
44<td>in</td>
45<th><CODE>attributes</CODE></th>
46<td>Attributes used for NSA searches. (May be omitted when not specifying attributes.)</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th><CODE>waitTimeoutSec</CODE></th>
51<td>Timeout for download processes. (The default value is applied if omitted. No timeout is set if <CODE>0</CODE> is specified.)</td>
52        </tr>
53        <tr>
54<td>in</td>
55<th><CODE>fileSize</CODE></th>
56<td>The size of the NSA list file to create. (The function creates an empty file of this size, and then writes the NSA list to it. If this parameter is omitted, the maximum size of an NSA list (<a href="../../../nn/boss/NsaList/NN_BOSS_NSALIST_MAX_SIZE.html"><CODE>NN_BOSS_NSALIST_MAX_SIZE</CODE></a>) is set. This function will return the error <CODE><a href="../../../nn/boss/ResultNSAListDownloadTaskError/Overview.html">ResultNSAListDownloadTaskError</a></CODE> if the size value is smaller than the downloaded NSA list.)</td>
57        </tr> </table>
58    </div>
59<h2>Return Values</h2>
60<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 />
61      <table class="arguments">
62        <thead>
63          <tr>
64<th>Value</th>
65<td>Description</td>
66          </tr>
67        </thead>
68        <tr>
69<th><CODE>Result::IsSuccess</CODE></th>
70<td>Retrieval successful.</td>
71        </tr>
72        <tr>
73<th><CODE>ResultWaitFinishTaskNotDone</CODE></th>
74<td>Task execution is stopped (<span>TASK_STOPPED</span> status). This result is returned when downloading the NSA list has been canceled.</td>
75        </tr>
76        <tr>
77<th><CODE>ResultWaitFinishTimeout</CODE></th>
78<td>The <CODE>WaitFinish</CODE> function timed out.</td>
79        </tr>
80        <tr>
81<th><CODE>ResultNSAListDownloadTaskError</CODE></th>
82<td>The result of the download task was an error.</td>
83        </tr>
84        <tr>
85<th><CODE>ResultUnexpect</CODE></th>
86<td>An unexpected result code (result code for which an error code is not allocated) is passed.</td>
87        </tr>
88        <tr>
89<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
90<td>The session has not been initialized. This result is returned if this function is called before the <CODE><a href="../../../nn/boss/Task/Initialize.html">Initialize</A></CODE> function. Always call the <a href="../../../nn/boss/Task/Initialize.html"><CODE>Initialize</CODE></a> function first thing when you use the BOSS library.</td>
91        </tr>
92        <tr>
93<th>A value other than the above.</th>
94<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
95        </tr>
96      </table> </div>
97<h2>Description</h2>
98    <div class="section">
99<p>Downloads the NSA list.</p><!-- write here --></div>
100<h2>Revision History</h2>
101    <div class="section">
102      <dl class="history">
103        <dt>2011/10/27</dt>
104<dd>Initial version.<br />
105        </dd>
106      </dl>
107    </div>
108  <hr><p>CONFIDENTIAL</p></body>
109</html>