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>ResultCode</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::ResultCode</CODE> Enumerated Type</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14enum ResultCode;
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>ER_NONE</CODE></th>
28<td>No error.</td>
29        </tr>
30        <tr>
31<th><CODE>ER_INVALID_POLICY</CODE></th>
32<td>The policy information pointer is <CODE>NULL</CODE>.</td>
33        </tr>
34        <tr>
35<th><CODE>ER_INVALID_ACTION</CODE></th>
36<td>The task action pointer is <CODE>NULL</CODE>.</td>
37        </tr>
38        <tr>
39<th><CODE>ER_INVALID_OPTION</CODE></th>
40<td>The task option pointer is <CODE>NULL</CODE>, or the option code is invalid.</td>
41        </tr>
42        <tr>
43<th><CODE>ER_INVALID_APPIDLIST</CODE></th>
44<td>The pointer for getting the application list is <CODE>NULL</CODE>.</td>
45        </tr>
46        <tr>
47<th><CODE>ER_INVALID_TASKID_LIST</CODE></th>
48<td>The pointer for getting the task ID list is <CODE>NULL</CODE>.</td>
49        </tr>
50        <tr>
51<th><CODE>ER_INVALID_STEPID_LIST</CODE></th>
52<td>The pointer for getting the step ID list is <CODE>NULL</CODE>.</td>
53        </tr>
54        <tr>
55<th><CODE>ER_INVALID_NSDATA_IDLIST</CODE></th>
56<td>The pointer to NS data list information is <CODE>NULL</CODE>.</td>
57        </tr>
58        <tr>
59<th><CODE>ER_INVALID_TASKSTATUS</CODE></th>
60<td>The task status pointer is <CODE>NULL</CODE>.</td>
61        </tr>
62        <tr>
63<th><CODE>ER_INVALID_PROPERTYVALUE</CODE></th>
64<td>The property value pointer is <CODE>NULL</CODE>.</td>
65        </tr>
66        <tr>
67<th><CODE>ER_INVALID_NEWARRIVAL_EVENT</CODE></th>
68<td>The pointer to the new arrival event is <CODE>NULL</CODE>.</td>
69        </tr>
70        <tr>
71<th><CODE>ER_INVALID_NEWARRIVAL_FLAG</CODE></th>
72<td>The pointer to the new arrival flag is <CODE>NULL</CODE>.</td>
73        </tr>
74        <tr>
75<th><CODE>ER_INVALID_OPTOUT_FLAG</CODE></th>
76<td>The pointer to the opt-out flag is <CODE>NULL</CODE>.</td>
77        </tr>
78        <tr>
79<th><CODE>ER_INVALID_TASKERROR</CODE></th>
80<td>The pointer to the task error information is <CODE>NULL</CODE>.</td>
81        </tr>
82        <tr>
83<th><CODE>ER_INVALID_NSDATA_VALUE</CODE></th>
84<td>The pointer to the region that stores NSDATA is <CODE>NULL</CODE>.</td>
85        </tr>
86        <tr>
87<th><CODE>ER_INVALID_NSDATA_INFO</CODE></th>
88<td>The pointer to the location that stores additional NSDATA information is <CODE>NULL</CODE>.</td>
89        </tr>
90        <tr>
91<th><CODE>ER_INVALID_NSDATA_READFLAG</CODE></th>
92<td>The pointer to the storage region for the NSDATA read flag is <CODE>NULL</CODE>.</td>
93        </tr>
94        <tr>
95<th><CODE>ER_INVALID_NSDATA_TIME</CODE></th>
96<td>The pointer to the region used to store the NSDATA update time is <CODE>NULL</CODE>.</td>
97        </tr>
98        <tr>
99<th><CODE>ER_INVALID_NEXTEXECUTETIME</CODE></th>
100<td>The pointer to the location used to store the minutes value of the next execution time is <CODE>NULL</CODE>.</td>
101        </tr>
102        <tr>
103<th><CODE>ER_HTTP_REQUEST_HEADER_POINTER_NULL</CODE></th>
104<td>The HTTP request header pointer is <CODE>NULL</CODE>.</td>
105        </tr>
106        <tr>
107<th><CODE>ER_INVALID_POLICYLIST_AVAILABILITY</CODE></th>
108<td>The pointer to information that can be used by the policy list is <CODE>NULL</CODE>.</td>
109        </tr>
110        <tr>
111<th><CODE>ER_INVALID_TESTMODE_AVAILABILITY</CODE></th>
112<td>The pointer to information usable in test mode is <CODE>NULL</CODE>.</td>
113        </tr>
114        <tr>
115<th><CODE>ER_INVALID_CONFIG_PARENTAL_CONTROL</CODE></th>
116<td>The pointer to information on Parental Controls settings is <CODE>NULL</CODE>.</td>
117        </tr>
118        <tr>
119<th><CODE>ER_INVALID_CONFIG_EULA_AGREEMENT</CODE></th>
120<td>The pointer to information on whether the user has agreed to the EULA is <CODE>NULL</CODE>.</td>
121        </tr>
122        <tr>
123<th><CODE>ER_INVALID_POLICYLIST_ENV_ID</CODE></th>
124<td>The pointer to the policy list's environment ID is <CODE>NULL</CODE>.</td>
125        </tr>
126        <tr>
127<th><CODE>ER_INVALID_POLICYLIST_URL</CODE></th>
128<td>The pointer to the policy list's URL information is <CODE>NULL</CODE>.</td>
129        </tr>
130        <tr>
131<th><CODE>ER_INVALID_TASK_ID</CODE></th>
132<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
133        </tr>
134        <tr>
135<th><CODE>ER_INVALID_TASK_STEP</CODE></th>
136<td>The current step ID was specified during task registration.</td>
137        </tr>
138        <tr>
139<th><CODE>ER_INVALID_PROPERTYTYPE</CODE></th>
140<td>The property type is not supported.</td>
141        </tr>
142        <tr>
143<th><CODE>ER_INVALID_URL</CODE></th>
144<td>The URL string pointer is <CODE>NULL</CODE> or a zero-length string.</td>
145        </tr>
146        <tr>
147<th><CODE>ER_INVALID_FILEPATH</CODE></th>
148<td>The file path string pointer is <CODE>NULL</CODE> or a zero-length string.</td>
149        </tr>
150        <tr>
151<th><CODE>ER_INVALID_TASK_PRIORITY</CODE></th>
152<td>The specified task priority is invalid.</td>
153        </tr>
154        <tr>
155<th><CODE>ER_INVALID_TASK_TARGETDURATION</CODE></th>
156<td>The task duration is invalid.</td>
157        </tr>
158        <tr>
159<th><CODE>ER_ACTIONCODE_OUT_OF_RANGE</CODE></th>
160<td>The task action code is invalid.</td>
161        </tr>
162        <tr>
163<th><CODE>ER_INVALID_NSDATA_SEEK_POSITION</CODE></th>
164<td>The NS data seek position exceeds the data size.</td>
165        </tr>
166        <tr>
167<th><CODE>ER_INVALID_MAX_HTTP_REQUEST_HEADER</CODE></th>
168<td>The HTTP request header registration count exceeds the maximum.</td>
169        </tr>
170        <tr>
171<th><CODE>ER_INVALID_MAX_CLIENT_CERT</CODE></th>
172<td>The number of client certificates set exceeds the maximum.</td>
173        </tr>
174        <tr>
175<th><CODE>ER_INVALID_MAX_ROOT_CA</CODE></th>
176<td>The number of root CAs exceeds the maximum that can be set.</td>
177        </tr>
178        <tr>
179<th><CODE>ER_SCHEDULING_POLICY_OUT_OF_RANGE</CODE></th>
180<td>The scheduling policy is invalid.</td>
181        </tr>
182        <tr>
183<th><CODE>ER_APINFOTYPE_OUT_OF_RANGE</CODE></th>
184<td>The AP information type is invalid.</td>
185        </tr>
186        <tr>
187<th><CODE>ER_TASK_PERMISSION_OUT_OF_RANGE</CODE></th>
188<td>The task permission information is invalid.</td>
189        </tr>
190        <tr>
191<th><CODE>ER_WAITFINISH_TIMEOUT</CODE></th>
192<td>The <CODE>WaitFinish</CODE> function timed out.</td>
193        </tr>
194        <tr>
195<th><CODE>ER_WAITFINISH_TASK_NOT_DONE</CODE></th>
196<td>The target task ended with a result other than <CODE>TASK_DONE</CODE> in the <CODE>WaitFinish</CODE> function.</td>
197        </tr>
198        <tr>
199<th><CODE>ER_IPC_NOT_SESSION_INITIALIZED</CODE></th>
200<td>Either the IPC session has not been initialized or permissions were incompatible.</td>
201        </tr>
202        <tr>
203<th><CODE>ER_IPC_PROPERTY_SIZE_ERROR</CODE></th>
204<td>There was a property size error during internal IPC processing.</td>
205        </tr>
206        <tr>
207<th><CODE>ER_IPC_TOO_MANY_REQUESTS</CODE></th>
208<td>There are too many IPC requests. (This is provided for future extensibility and cannot be used.)</td>
209        </tr>
210        <tr>
211<th><CODE>ER_ALREADY_INITIALIZED</CODE></th>
212<td>IPC is already initialized.</td>
213        </tr>
214        <tr>
215<th><CODE>ER_OUT_OF_MEMORY</CODE></th>
216<td>Insufficient memory.</td>
217        </tr>
218        <tr>
219<th><CODE>ER_INVALID_NUMBER_OF_NSD</CODE></th>
220<td>The maximum number of NSD files in the NSA was exceeded.</td>
221        </tr>
222        <tr>
223<th><CODE>ER_NSDATA_INVALID_FORMAT</CODE></th>
224<td>An invalid NS data format was detected.</td>
225        </tr>
226        <tr>
227<th><CODE>ER_APLI_NOT_EXIST</CODE></th>
228<td>The specified application ID was not found.</td>
229        </tr>
230        <tr>
231<th><CODE>ER_TASK_NOT_EXIST</CODE></th>
232<td>The specified task ID was not found.</td>
233        </tr>
234        <tr>
235<th><CODE>ER_TASK_STEP_NOT_EXIST</CODE></th>
236<td>The specified task step was not found.</td>
237        </tr>
238        <tr>
239<th><CODE>ER_APLI_ID_ALREADY_EXIST</CODE></th>
240<td>Another application of the same name is already registered.</td>
241        </tr>
242        <tr>
243<th><CODE>ER_TASK_ID_ALREADY_EXIST</CODE></th>
244<td>Another task of the same name is already registered.</td>
245        </tr>
246        <tr>
247<th><CODE>ER_TASK_STEP_ALREADY_EXIST</CODE></th>
248<td>Another task step of the same name is already registered.</td>
249        </tr>
250        <tr>
251<th><CODE>ER_INVALID_SEQUENCE</CODE></th>
252<td>A sequence error (such as an attempt to start a task that is currently running) was detected.</td>
253        </tr>
254        <tr>
255<th><CODE>ER_DATABASE_FULL</CODE></th>
256<td>Storage and tasks cannot be registered because the maximum number of registered application IDs and tasks has been reached.</td>
257        </tr>
258        <tr>
259<th><CODE>ER_CANT_UNREGISTER_TASK</CODE></th>
260<td>The task cannot be deleted because of its state (for example, it may currently be running or have already been scheduled).</td>
261        </tr>
262        <tr>
263<th><CODE>ER_TASK_NOT_REGISTERED</CODE></th>
264<td>A task that should be registered in the database file was not found.</td>
265        </tr>
266        <tr>
267<th><CODE>ER_INVALID_FILEHANDLE</CODE></th>
268<td>Invalid file handle.</td>
269        </tr>
270        <tr>
271<th><CODE>ER_INVALID_TASK_SCHEDULING_POLICY</CODE></th>
272<td>An invalid keyword was detected in the scheduling policy list.</td>
273        </tr>
274        <tr>
275<th><CODE>ER_INVALID_HTTP_REQUEST_HEADER</CODE></th>
276<td>More than the maximum number of option HTTP request headers were specified.</td>
277        </tr>
278        <tr>
279<th><CODE>ER_INVALID_HEADTYPE</CODE></th>
280<td>An invalid header type was specified in the <CODE>GetHeaderInfo</CODE> function.</td>
281        </tr>
282        <tr>
283<th><CODE>ER_STORAGE_ACCESSPERMISSION</CODE></th>
284<td>You do not have permission to access storage.</td>
285        </tr>
286        <tr>
287<th><CODE>ER_STORAGE_INSUFFICIENCY</CODE></th>
288<td>Insufficient storage space.</td>
289        </tr>
290        <tr>
291<th><CODE>ER_INVALID_APPID_STORAGE_NOTFOUND</CODE></th>
292<td>Storage has not been registered for the corresponding application ID.</td>
293        </tr>
294        <tr>
295<th><CODE>ER_NSDATA_NOTFOUND</CODE></th>
296<td>The specified NS data was not found.</td>
297        </tr>
298        <tr>
299<th><CODE>ER_INVALID_NSDATA_GETHEAD_SIZE</CODE></th>
300<td>The header size does not match the header type specified by the <CODE>GetHeaderInfo</CODE> function.</td>
301        </tr>
302        <tr>
303<th><CODE>ER_NSDATA_LIST_SIZE_SHORTAGE</CODE></th>
304<td>The <CODE>NsDataIdList</CODE> size is insufficient (the list is not big enough to store all the NSD serial IDs).</td>
305        </tr>
306        <tr>
307<th><CODE>ER_NSDATA_LIST_UPDATED</CODE></th>
308<td>The target NSD group for BOSS storage was updated since the last time a list was obtained.</td>
309        </tr>
310        <tr>
311<th><CODE>ER_NOT_CONNECT_AP_WITH_LOCATION</CODE></th>
312<td>Not connected to an access point.</td>
313        </tr>
314        <tr>
315<th><CODE>ER_NOT_CONNECT_NETWORK</CODE></th>
316<td>Not connected to a network.</td>
317        </tr>
318        <tr>
319<th><CODE>ER_INVALID_FRIENDCODE</CODE></th>
320<td>Invalid friend code error.</td>
321        </tr>
322        <tr>
323<th><CODE>ER_FILE_ACCESS</CODE></th>
324<td>Failed to access a file. An abnormality has occurred in the system save data when accessing the internal database and settings information. This normally does not arise.  The problem may disappear by initializing the system save data, but doing so will delete all task information (including the information registered by other applications).</td>
325        </tr>
326        <tr>
327<th><CODE>ER_TASK_ALREADY_PAUSED</CODE></th>
328<td>Already paused.</td>
329        </tr>
330        <tr>
331<th><CODE>ER_TASK_ALREADY_RESUMED</CODE></th>
332<td>Already resumed.</td>
333        </tr>
334        <tr>
335<th><CODE>ER_UNEXPECT</CODE></th>
336<td>An unexpected error occurred.</td>
337        </tr>
338        <tr>
339<th><CODE>RESULT_CODE_LAST</CODE></th>
340<td>This value is not used.</td>
341        </tr>
342        <tr>
343<th><CODE>RESULT_CODE_MAX_VALUE</CODE></th>
344          <td>
345        </td>
346        </tr>
347      </table> </div>
348<h2>Description</h2>
349    <div class="section">
350<p>Function result codes. Set as the <CODE>description</CODE> for <CODE>bossResult</CODE>, and used as the return value for <CODE>boss</CODE> functions.</p><!-- write here --></div>
351<h2>Revision History</h2>
352    <div class="section">
353      <dl class="history">
354        <dt>2010/09/16</dt>
355<dd>Initial version.<br />
356        </dd>
357      </dl>
358    </div>
359  <hr><p>CONFIDENTIAL</p></body>
360</html>