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>PropertyType</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/boss/Overview.html">boss</a>::PropertyType</CODE> Enumerated Type</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14enum PropertyType;
15</pre>
16    </div>
17<h2>Value</h2>
18    <div class="section">
19      <table class="arguments">
20        <thead>
21          <tr>
22<th>Value</th>
23<td>Description</td>
24          </tr>
25        </thead>
26        <tr>
27<th><CODE>TASK_PRIORITY</CODE></th>
28<td><CODE>0</CODE>: The task execution priority set during task registration. Data type is <CODE>TaskPriority</CODE>.</td>
29        </tr>
30        <tr>
31<th><CODE>TASK_SCHEDULING_POLICY</CODE></th>
32<td><CODE>1</CODE>: Scheduling policy of the task. The data type is <CODE>SchedulingPolicy</CODE>.</td>
33        </tr>
34        <tr>
35<th><CODE>TASK_TARGET_DURATION</CODE></th>
36<td><CODE>2</CODE>: Targeted task execution time. The data type is <CODE>u32</CODE> (seconds). (This is provided for future extensibility and cannot be used.)</td>
37        </tr>
38        <tr>
39<th><CODE>TASK_EXEC_INTERVAL</CODE></th>
40<td><CODE>3</CODE>: Task execution interval. The data type is <CODE>u32</CODE> (seconds).</td>
41        </tr>
42        <tr>
43<th><CODE>TASK_EXEC_COUNT</CODE></th>
44<td><CODE>4</CODE>: Task execution count. The data type is <CODE>u32</CODE>.</td>
45        </tr>
46        <tr>
47<th><CODE>TASK_PERMISSION</CODE></th>
48<td><CODE>5</CODE>: Task execution restrictions as set by Parental Controls and EULA permissions. The data type is <CODE>TaskPermission</CODE>.</td>
49        </tr>
50        <tr>
51<th><CODE>ACTION_CODE</CODE></th>
52<td><CODE>6</CODE>: The code for a task's type. The data type is <CODE>Action</CODE>.</td>
53        </tr>
54        <tr>
55<th><CODE>ACTION_URL</CODE></th>
56<td><CODE>7</CODE>: Target URL. The data type is <CODE>char[MAX_URL_LENGTH]</CODE>.</td>
57        </tr>
58        <tr>
59<th><CODE>ACTION_OFFSET</CODE></th>
60<td><CODE>8</CODE>: The offset from the starting position of the data specified by the URL. The data type is <CODE>u32</CODE>.</td>
61        </tr>
62        <tr>
63<th><CODE>ACTION_FILEDESC</CODE></th>
64<td><CODE>9</CODE>: File descriptor type. The data type is <CODE>FileDescriptor</CODE>.</td>
65        </tr>
66        <tr>
67<th><CODE>ACTION_FILEPATH</CODE></th>
68<td><CODE>10</CODE>: The file path targeted by the task. The data type is <CODE>char[MAX_FILEPATH_LENGTH]</CODE>.</td>
69        </tr>
70        <tr>
71<th><CODE>ACTION_FILEPATH_W</CODE></th>
72<td><CODE>11</CODE>: The file path targeted by the task. The data type is <CODE>wchar_t[MAX_FILEPATH_LENGTH]</CODE>.</td>
73        </tr>
74        <tr>
75<th><CODE>ACTION_FILE_HANDLE</CODE></th>
76<td><CODE>12</CODE>: The file handle targeted by the task. The data type is <CODE>nnHandle</CODE>.</td>
77        </tr>
78        <tr>
79<th><CODE>ACTION_HTTP_HEADER</CODE></th>
80<td><CODE>13</CODE>: Structure for URL option request headers. The data type is <CODE>struct httpRequestHeader[MAX_HTTP_HEADER]</CODE>.</td>
81        </tr>
82        <tr>
83<th><CODE>ACTION_CLIENT_CERT</CODE></th>
84<td><CODE>14</CODE>: The built-in client certificate for HTTPS communication. The data type is <CODE>u32[MAX_CLIENT_CERT]</CODE>.</td>
85        </tr>
86        <tr>
87<th><CODE>ACTION_ROOT_CA</CODE></th>
88<td><CODE>15</CODE>: The internal root certificate for HTTPS communication. The data type is <CODE>u32[MAX_ROOT_CA]</CODE>.</td>
89        </tr>
90        <tr>
91<th><CODE>ACTION_PRIVATE_CLIENT_CERT</CODE></th>
92<td><CODE>16</CODE>: Flag for enabling a private client certificate. Data type is <CODE>u8</CODE>.</td>
93        </tr>
94        <tr>
95<th><CODE>ACTION_PRIVATE_ROOT_CA</CODE></th>
96<td><CODE>17</CODE>: Flag for enabling a private client certificate. Data type is <CODE>u8</CODE>.</td>
97        </tr>
98        <tr>
99<th><CODE>ACTION_AP_INFO</CODE></th>
100<td><CODE>18</CODE>: Type for access point information for attaching AP information to an HTTP query. It has a data type of <CODE>ApInfoType</CODE>.</td>
101        </tr>
102        <tr>
103<th><CODE>ACTION_CLIENT_CERT_NUM</CODE></th>
104<td><CODE>19</CODE>: Number of configured built-in client certificates. The data type is <CODE>u32</CODE>.</td>
105        </tr>
106        <tr>
107<th><CODE>ACTION_ROOT_CA_NUM</CODE></th>
108<td><CODE>20</CODE>: The number of internal root certificates to specify. The data type is <CODE>u32</CODE>.</td>
109        </tr>
110        <tr>
111<th><CODE>ACTION_LAST_MODIFIED_TIME</CODE></th>
112<td><CODE>21</CODE>: The &quot;Last-Modified&quot; date and time to set in the HTTP request header. Data type is <CODE>char[MAX_LASTMODIFIED_LENGTH]</CODE>.</td>
113        </tr>
114        <tr>
115<th><CODE>ACTION_SERIAL_ID</CODE></th>
116<td><CODE>22</CODE>: A title ID for startup tasks. The data type is <CODE>nnfs::TitleId</CODE>. (This is provided for future extensibility and cannot be used.)</td>
117        </tr>
118        <tr>
119<th><CODE>SIGNAL_TASK_EVENT</CODE></th>
120<td><CODE>23</CODE>: Event for startup tasks. The data type is <CODE>nnos::Event*</CODE>. (This is provided for future extensibility and cannot be used.)</td>
121        </tr>
122        <tr>
123<th><CODE>TASK_EXEC_OPTION</CODE></th>
124<td><CODE>24</CODE>: Task execution options. Data type is <CODE>ExecOption</CODE>.</td>
125        </tr>
126        <tr>
127<th><CODE>TASK_STEP</CODE></th>
128<td><CODE>25</CODE>: Task step ID number. Data type is <CODE>u8</CODE>.</td>
129        </tr>
130        <tr>
131<th><CODE>TASK_OPTION_TARGET_STEP</CODE></th>
132<td><CODE>26</CODE>: Task step option ID number. Data type is <CODE>u8</CODE>. (This is provided for future extensibility and cannot be used.)</td>
133        </tr>
134        <tr>
135<th><CODE>TASK_OPTION_PARAM1</CODE></th>
136<td><CODE>27</CODE>: Option parameter 1 for task step execution. The data type is <CODE>u32</CODE>. (This is provided for future extensibility and cannot be used.)</td>
137        </tr>
138        <tr>
139<th><CODE>TASK_OPTION_PARAM2</CODE></th>
140<td><CODE>28</CODE>: Option parameter 2 for task step execution. The data type is <CODE>u32</CODE>. (This is provided for future extensibility and cannot be used.)</td>
141        </tr>
142        <tr>
143<th><CODE>TASK_STATE_CODE</CODE></th>
144<td><CODE>29</CODE>: Task state information. Its data type is <CODE>TaskStateCode</CODE>.</td>
145        </tr>
146        <tr>
147<th><CODE>TASK_STATE_TASK</CODE></th>
148<td><CODE>30</CODE>: Internal task state information. Its data type is <CODE>TaskStateCode</CODE>.</td>
149        </tr>
150        <tr>
151<th><CODE>TASK_STATE_RESUME</CODE></th>
152<td><CODE>31</CODE>: Internal task state information. Its data type is <CODE>TaskStateCode</CODE>.</td>
153        </tr>
154        <tr>
155<th><CODE>TASK_RESULT_CODE</CODE></th>
156<td><CODE>32</CODE>: Task result code. Its data type is <CODE>TaskResultCode</CODE>.</td>
157        </tr>
158        <tr>
159<th><CODE>TASK_SERVICE_STATUS</CODE></th>
160<td><CODE>33</CODE>: Status of the service pointed to by the URL specified in the task attributes. Its data type is <CODE>TaskServiceStatus</CODE>.</td>
161        </tr>
162        <tr>
163<th><CODE>TASK_SERVICE_TERMINATED</CODE></th>
164<td><CODE>34</CODE>: Availability flag of the service pointed to by the URL specified in the task attributes. Its data type is <CODE>bool</CODE>.</td>
165        </tr>
166        <tr>
167<th><CODE>TASK_COMM_ERROR_CODE</CODE></th>
168<td><CODE>35</CODE>: Communications error code during task execution. The data type is <CODE>u32</CODE>.</td>
169        </tr>
170        <tr>
171<th><CODE>TASK_CURRENT_PRIORITY</CODE></th>
172<td><CODE>36</CODE>: Priority of the currently running task. Data type is <CODE>TaskPriority</CODE>.</td>
173        </tr>
174        <tr>
175<th><CODE>TASK_EXECUTE_COUNT</CODE></th>
176<td><CODE>37</CODE>: Task execution count. The data type is <CODE>u32</CODE>.</td>
177        </tr>
178        <tr>
179<th><CODE>TASK_PENDING_TIME</CODE></th>
180<td><CODE>38</CODE>: The time elapsed since the task was scheduled to start. The data type is <CODE>u32</CODE> (seconds).</td>
181        </tr>
182        <tr>
183<th><CODE>TASK_REMAIN_TIME</CODE></th>
184<td><CODE>39</CODE>: Time remaining until task execution. The data type is <CODE>u32</CODE> (seconds). (This is provided for future extensibility and cannot be used.)</td>
185        </tr>
186        <tr>
187<th><CODE>TASK_START_TIME</CODE></th>
188<td><CODE>40</CODE>: Task execution time based on the reference 2000/1/1. Its data type is <CODE>s64</CODE> (seconds).</td>
189        </tr>
190        <tr>
191<th><CODE>TASK_STEP_START_TIME</CODE></th>
192<td><CODE>41</CODE>: Task execution time based on the reference 2000/1/1. Its data type is <CODE>s64</CODE> (seconds). (This is provided for future extensibility and cannot be used.)</td>
193        </tr>
194        <tr>
195<th><CODE>TASK_PROGRESS</CODE></th>
196<td><CODE>42</CODE>: Number of bytes downloaded. The data type is <CODE>u32</CODE>.</td>
197        </tr>
198        <tr>
199<th><CODE>TASK_DATA_SIZE</CODE></th>
200<td><CODE>43</CODE>: Total number of bytes to download from specified URL. The data type is <CODE>u32</CODE>.</td>
201        </tr>
202        <tr>
203<th><CODE>TASK_CURRENT_STEP</CODE></th>
204<td><CODE>44</CODE>: Currently running task step ID. Data type is <CODE>u8</CODE>.</td>
205        </tr>
206        <tr>
207<th><CODE>TASK_ACTIVE_RATE</CODE></th>
208<td><CODE>45</CODE> Average active rate. The data type is <CODE>u16</CODE>. (This is provided for future extensibility and cannot be used.)</td>
209        </tr>
210        <tr>
211<th><CODE>TASK_REQUEST_RATE</CODE></th>
212<td><CODE>46</CODE>: Average communication request rate. The data type is <CODE>u16</CODE>. (This is provided for future extensibility and cannot be used.)</td>
213        </tr>
214        <tr>
215<th><CODE>TASK_LAST_MODIFIED_TIME</CODE></th>
216<td><CODE>47</CODE>: Last update time, as returned in the HTTP response header. Data type is <CODE>char[MAX_LASTMODIFIED_LENGTH]</CODE>.</td>
217        </tr>
218        <tr>
219<th><CODE>TASK_ERROR_RESULT_CODE</CODE></th>
220<td><CODE>48</CODE>: Task result code. Its data type is <CODE>TaskResultCode</CODE>.</td>
221        </tr>
222        <tr>
223<th><CODE>TASK_ERROR_CODE</CODE></th>
224<td><CODE>49</CODE>: Communications error code during task execution. The data type is <CODE>u32</CODE>.</td>
225        </tr>
226        <tr>
227<th><CODE>TASK_ERROR_MESSAGE</CODE></th>
228<td><CODE>50</CODE>: Communications error message during task execution. Its data type is <CODE>char[MAX_ERROR_MESSAGE]</CODE>.</td>
229        </tr>
230        <tr>
231<th><CODE>TASK_APPID_LIST_SIZE</CODE></th>
232<td><CODE>51</CODE>: Internal size for the <CODE>ApplicationIdList</CODE> class. The data type is <CODE>u16</CODE>. (This enumerator is used for internal processing.)</td>
233        </tr>
234        <tr>
235<th><CODE>TASK_APPID_LIST</CODE></th>
236<td><CODE>52</CODE>: An internal application ID list for the <CODE>ApplicationIdList</CODE> class. It has a data type of <CODE>AppIdType[MAX_APPLICATION_ID]</CODE>. (This enumerator is used for internal processing.)</td>
237        </tr>
238        <tr>
239<th><CODE>TASK_TASKID_LIST_SIZE</CODE></th>
240<td><CODE>53</CODE>: Internal size for the <CODE>TaskIdList</CODE> class. The data type is <CODE>u16</CODE>. (This enumerator is used for internal processing.)</td>
241        </tr>
242        <tr>
243<th><CODE>TASK_TASKID_LIST</CODE></th>
244<td><CODE>54</CODE>: An internal task ID list for the <CODE>TaskIdList</CODE> class. Its data type is <CODE>u8[MAX_TASK_ID][TASK_ID_LENGTH]</CODE>. (This enumerator is used for internal processing.)</td>
245        </tr>
246        <tr>
247<th><CODE>TASK_STEPID_LIST_SIZE</CODE></th>
248<td><CODE>55</CODE>: Internal size for the <CODE>StepIdList</CODE> class. The data type is <CODE>u16</CODE>. (This enumerator is used for internal processing.)</td>
249        </tr>
250        <tr>
251<th><CODE>TASK_STEPID_LIST</CODE></th>
252<td><CODE>56</CODE>: An internal task step ID list for the <CODE>StepIdList</CODE> class. Its data type is <CODE>u8[MAX_TASK_ID]</CODE>. (This enumerator is used for internal processing.)</td>
253        </tr>
254        <tr>
255<th><CODE>TASK_NSDATA_LIST_SIZE</CODE></th>
256<td><CODE>57</CODE>: Internal size for the <CODE>NsDataIdList</CODE> class. The data type is <CODE>u16</CODE>. (This enumerator is used for internal processing.)</td>
257        </tr>
258        <tr>
259<th><CODE>TASK_NSDATA_LIST</CODE></th>
260<td><CODE>58</CODE>: An internal <CODE>NsData</CODE> list for the <CODE>NsDataIdList</CODE> class. Its data type is <CODE>u32[serialSize]</CODE>. (This enumerator is used for internal processing.)</td>
261        </tr>
262        <tr>
263<th><CODE>ACTION_SIGNAL_TASK_EVENT</CODE></th>
264<td><CODE>59</CODE>: Event for startup tasks. The data type is <CODE>nnos::Event*</CODE>. (This is provided for future extensibility and cannot be used.)</td>
265        </tr>
266        <tr>
267<th><CODE>ACTION_HTTP_HEADER_VALUE</CODE></th>
268<td><CODE>60</CODE>: (This enumerator is used for internal processing. It cannot be used from the application.)</td>
269        </tr>
270        <tr>
271<th><CODE>TASK_ID</CODE></th>
272<td><CODE>61</CODE>: (This enumerator is used for internal processing. It cannot be used from the application.)</td>
273        </tr>
274        <tr>
275<th><CODE>ACTION_FILE_PARAM</CODE></th>
276<td><CODE>62</CODE>: (This enumerator is used for internal processing. It cannot be used from the application.)</td>
277        </tr>
278        <tr>
279<th><CODE>ACTION_CFG_INFO</CODE></th>
280<td><CODE>63</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. System information type used to return system configuration information in response to HTTP queries. The data type is <CODE>CfgInfoType</CODE>.</td>
281        </tr>
282        <tr>
283<th><CODE>ACTION_DATASTORE_GAME_ID</CODE></th>
284<td><CODE>64</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. ID used to identify the game server. The data type is <CODE>u32</CODE>. (Enabled only for <CODE>DataStore</CODE> upload and download tasks.)</td>
285        </tr>
286        <tr>
287<th><CODE>ACTION_DATASTORE_ACCESS_KEY</CODE></th>
288<td><CODE>65</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Key used to access the game server. The data type is <CODE>wchar_t[MAX_ACCESS_KEY_LENGTH]</CODE>. (Enabled only for <CODE>DataStore</CODE> upload and download tasks.)</td>
289        </tr>
290        <tr>
291<th><CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_SUBJECT</CODE></th>
292<td><CODE>66</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Notification data subject title. The data type is <CODE>wchar_t[MAX_NEWS_SUBJECT_LENGTH</CODE>]. (Enabled only for <CODE>DataStore</CODE> download tasks.)</td>
293        </tr>
294        <tr>
295<th><CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_MESSAGE</CODE></th>
296<td><CODE>67</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Notification data body. The data type is <CODE>wchar_t[MAX_NEWS_MESSAGE_LENGTH</CODE>]. (Enabled only for <CODE>DataStore</CODE> download tasks.)</td>
297        </tr>
298        <tr>
299<th><CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_JUMP_PARAM</CODE></th>
300<td><CODE>68</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Notification data jump general-purpose parameters. The data type is <CODE>u8[MAX_NEWS_PARAM]</CODE>. (Enabled only for <CODE>DataStore</CODE> download tasks.)</td>
301        </tr>
302        <tr>
303<th><CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_MODE</CODE></th>
304<td><CODE>69</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Indicates whether notification data has been issued. The data type is <CODE>NewsMode</CODE>. (Enabled only for <CODE>DataStore</CODE> download tasks.)</td>
305        </tr>
306        <tr>
307<th><CODE>ACTION_DATASTORE_DOWNLOAD_NEWS_SERIAL_ID</CODE></th>
308<td><CODE>70</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Notification data serial ID. The data type is <CODE>bit 32</CODE>. (Enabled only for <CODE>DataStore</CODE> download tasks.)</td>
309        </tr>
310        <tr>
311<th><CODE>ACTION_DATASTORE_UPLOAD_PERIOD</CODE></th>
312<td><CODE>71</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. The number of days until data is automatically updated. The data type is <CODE>u16</CODE>. (Enabled only for <CODE>DataStore</CODE> upload tasks.)</td>
313        </tr>
314        <tr>
315<th><CODE>ACTION_DATASTORE_UPLOAD_DATA_TYPE</CODE></th>
316<td><CODE>72</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Value indicating the data type The data type is <CODE>u16</CODE>. (Enabled only for <CODE>DataStore</CODE> upload tasks.)</td>
317        </tr>
318        <tr>
319<th><CODE>ACTION_DATASTORE_UPLOAD_DST_PRINCIPAL_ID_NUM</CODE></th>
320<td><CODE>73</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. The number of message data sent destination settings. The data type is <CODE>u16</CODE>. (Enabled only for <CODE>DataStore</CODE> upload tasks.)</td>
321        </tr>
322        <tr>
323<th><CODE>ACTION_DATASTORE_UPLOAD_DST_KIND</CODE></th>
324<td><CODE>74</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Message data send destination type. The data type is <CODE>DstKind</CODE>. (Enabled only for <CODE>DataStore</CODE> upload tasks.)</td>
325        </tr>
326        <tr>
327<th><CODE>ACTION_DATASTORE_UPLOAD_DST_PRINCIPAL_ID</CODE></th>
328<td><CODE>75</CODE>: A constant used to access <CODE>TaskAction</CODE> attributes. Message data send destination ID. The data type is <CODE>u32[MAX_DST_PRINCIPAL_ID]</CODE>. (Enabled only for <CODE>DataStore</CODE> upload tasks.)</td>
329        </tr>
330        <tr>
331<th><CODE>PROPERTY_TYPE_MAX_VALUE</CODE></th>
332<td>(This enumerator is used for internal processing. It cannot be used from the application.)</td>
333        </tr>
334      </table> </div>
335<h2>Description</h2>
336    <div class="section">
337<p>Constants specifying properties. (The numeric value of each enumerator is shown at the start of its description.)</p><!-- write here --></div>
338<h2>Revision History</h2>
339    <div class="section">
340      <dl class="history">
341        <dt>2010/09/16</dt>
342<dd>Initial version.<br />
343        </dd>
344      </dl>
345    </div>
346  <hr><p>CONFIDENTIAL</p></body>
347</html>