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::DataStoreUploadAction</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/boss/Overview.html">boss</a>::DataStoreUploadAction</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56<pre class="definition">class DataStoreUploadAction :public <a href="../../../nn/boss/TaskAction/Overview.html">nn::boss::TaskAction</a></pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Class for representing <CODE>DataStore</CODE> upload tasks. Use this to do such things as register DataStore upload tasks.</p><p><I>DataStore</I> is one of the NEX library data storage features. It can upload data to and download data from storage, and it also allows users to exchange data. (For more details, see the documentation in the NEX library.))<br /> BOSS DataStore tasks are provided for using these DataStore features via BOSS (SpotPass).<br /> You can use BOSS DataStore tasks for DataStore uploads and downloads even when your application is not running (when the system is in Sleep Mode, for example).<br /></p><p>While uploading data, you cannot reuse a task that has already been registered. If a task having the same task ID has already been registered using <a href="../../../nn/boss/RegisterTask.html"><CODE>RegisterTask</CODE></a> (<a href="../../../nn/boss/ResultTaskIdAlreadyExist/Overview.html"><CODE>ResultTaskIdAlreadyExist</CODE></a>), be sure to first unregister the task in question using <a href="../../../nn/boss/UnregisterTask.html"><CODE>UnregisterTask</CODE></a> and then register it again.</p><p>If the system loses power while a task is being registered, the registered task and file information will be invalid. Data cannot be uploaded properly with such a task, so you must use the following procedure to check and handle it.<br /><br />Immediately after a task has been registered successfully, implement that a start command be performed using the <a href="../../../nn/boss/Task/Start.html"><CODE>nn::boss::Task::Start</CODE></a>, <a href="../../../nn/boss/Task/StartImmediate.html"><CODE>nn::boss::Task::StartImmediate</CODE></a>, or <a href="../../../nn/boss/Task/StartBgImmediate.html"><CODE>nn::boss::Task::StartBgImmediate</CODE></a> function. If the system loses power while a task is being registered—preventing it from starting—you can still detect the task because its state as obtained by the <a href="../../../nn/boss/Task/GetState.html"><CODE>nn::boss::Task::GetState</CODE></a> function will be <CODE>TASK_REGISTERED</CODE>. (The task's state will not be <CODE>TASK_REGISTERED</CODE> if the start command succeeded. ) Use the <a href="../../../nn/boss/UnregisterTask.html"><CODE>UnregisterTask</CODE></a> function to delete tasks like this and then re-register them.<br /></p><!-- write here --></div> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> </td> 67 <th> 68<a href="../../../nn/boss/DataStoreUploadAction/DataStoreUploadAction.html"><CODE>DataStoreUploadAction</CODE></a> 69 </th> 70<td>Constructor.</td> 71 </tr> 72 <tr> 73<td width="100"> <span class="virtual_style" title="virtual">V</span> 74 </td> 75 <th> 76<a href="../../../nn/boss/DataStoreUploadAction/~DataStoreUploadAction.html"><CODE>~DataStoreUploadAction</CODE></a> 77 </th> 78<td>Destructor.</td> 79 </tr> 80 <tr> 81 <td width="100"> </td> 82 <th> 83<a href="../../../nn/boss/DataStoreUploadAction/Initialize.html"><CODE>Initialize</CODE></a> 84 </th> 85<td>Used to configure <CODE>DataStore</CODE> upload.</td> 86 </tr> 87 <tr> 88 <td width="100"> </td> 89 <th> 90<a href="../../../nn/boss/DataStoreUploadAction/GetDstCount.html"><CODE>GetDstCount</CODE></a> 91 </th> 92<td>Returns the number of entries registered as destinations for sending data.</td> 93 </tr> 94 <tr> 95 <td width="100"> </td> 96 <th> 97<a href="../../../nn/boss/DataStoreUploadAction/AddDstPrincipalId.html"><CODE>AddDstPrincipalId</CODE></a> 98 </th> 99<td>Adds a destination to send data.</td> 100 </tr> 101 <tr> 102 <td width="100"> </td> 103 <th> 104<a href="../../../nn/boss/DataStoreUploadAction/ClearDstPrincipalId.html"><CODE>ClearDstPrincipalId</CODE></a> 105 </th> 106<td>Clears all destinations to send data.</td> 107 </tr> 108 <tr> 109<td width="100"> <span class="virtual_style" title="virtual">V</span> 110 </td> 111 <th> 112<a href="../../../nn/boss/DataStoreUploadAction/GetProperty.html"><CODE>GetProperty</CODE></a> 113 </th> 114<td>Gets a property value from the class.</td> 115 </tr> </table> 116 </div> 117 </a> 118<h2>Class Hierarchy</h2> 119 <div class="section"> 120<p class="hierarchy"><a href="../../../nn/boss/TaskActionBase/Overview.html"><CODE>nn::boss::TaskActionBase</CODE></a><br /> <a href="../../../nn/boss/TaskAction/Overview.html"><CODE>nn::boss::TaskAction</CODE></a><br /> <b><CODE>nn::boss::DataStoreUploadAction</CODE></b> 121 </p> 122 </div> 123<h2>Revision History</h2> 124 <div class="section"> 125 <dl class="history"> 126 <dt>2011/10/27</dt> 127<dd>Initial version.<br /> 128 </dd> 129 </dl> 130 </div> 131 <hr><p>CONFIDENTIAL</p></body> 132</html>