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>ER_NONE</th>
28          <td>No error.</td>
29        </tr>
30        <tr>
31          <th>ER_INVALID_POLICY</th>
32          <td>The policy information pointer is <CODE>NULL</CODE>.</td>
33        </tr>
34        <tr>
35          <th>ER_INVALID_ACTION</th>
36          <td>The task action pointer is <CODE>NULL</CODE>.</td>
37        </tr>
38        <tr>
39          <th>ER_INVALID_OPTION</th>
40          <td>The task option pointer is <CODE>NULL</CODE>, or the option code is invalid.</td>
41        </tr>
42        <tr>
43          <th>ER_INVALID_APPIDLIST</th>
44          <td>The pointer for getting the application list is <CODE>NULL</CODE>.</td>
45        </tr>
46        <tr>
47          <th>ER_INVALID_TASKID_LIST</th>
48          <td>The pointer for getting the task ID list is <CODE>NULL</CODE>.</td>
49        </tr>
50        <tr>
51          <th>ER_INVALID_STEPID_LIST</th>
52          <td>The pointer for getting the step ID list is <CODE>NULL</CODE>.</td>
53        </tr>
54        <tr>
55          <th>ER_INVALID_NSDATA_IDLIST</th>
56          <td>The NS data list information pointer is <CODE>NULL</CODE>.</td>
57        </tr>
58        <tr>
59          <th>ER_INVALID_TASKSTATUS</th>
60          <td>The task status pointer is <CODE>NULL</CODE>.</td>
61        </tr>
62        <tr>
63          <th>ER_INVALID_PROPERTYVALUE</th>
64          <td>The property value pointer is <CODE>NULL</CODE>.</td>
65        </tr>
66        <tr>
67          <th>ER_INVALID_NEWARRIVAL_EVENT</th>
68          <td>The new arrival event pointer is <CODE>NULL</CODE>.</td>
69        </tr>
70        <tr>
71          <th>ER_INVALID_NEWARRIVAL_FLAG</th>
72          <td>The new arrival flag pointer is <CODE>NULL</CODE>.</td>
73        </tr>
74        <tr>
75          <th>ER_INVALID_OPTOUT_FLAG</th>
76          <td>The optout flag pointer is <CODE>NULL</CODE>.</td>
77        </tr>
78        <tr>
79          <th>ER_INVALID_TASKERROR</th>
80          <td>The task error information pointer is <CODE>NULL</CODE>.</td>
81        </tr>
82        <tr>
83          <th>ER_INVALID_NSDATA_VALUE</th>
84          <td>The NSDATA storage region pointer is <CODE>NULL</CODE>.</td>
85        </tr>
86        <tr>
87          <th>ER_INVALID_NSDATA_INFO</th>
88          <td>The NSDATA additional information storage region pointer is <CODE>NULL</CODE>.</td>
89        </tr>
90        <tr>
91          <th>ER_INVALID_NSDATA_READFLAG</th>
92          <td>The NSDATA read flag storage region pointer is <CODE>NULL</CODE>.</td>
93        </tr>
94        <tr>
95          <th>ER_INVALID_NSDATA_TIME</th>
96          <td>The NSDATA update time storage region pointer is <CODE>NULL</CODE>.</td>
97        </tr>
98        <tr>
99          <th>ER_INVALID_NEXTEXECUTETIME</th>
100          <td>The next execute time minutes pointer is <CODE>NULL</CODE>.</td>
101        </tr>
102        <tr>
103          <th>ER_HTTP_REQUEST_HEADER_POINTER_NULL</th>
104          <td>The HTTP request header pointer is <CODE>NULL</CODE>.</td>
105        </tr>
106        <tr>
107          <th>ER_INVALID_POLICYLIST_AVAILABILITY</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>ER_INVALID_TESTMODE_AVAILABILITY</th>
112          <td>The pointer to information usable in test mode is <CODE>NULL</CODE>.</td>
113        </tr>
114        <tr>
115          <th>ER_INVALID_TASK_ID</th>
116          <td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
117        </tr>
118        <tr>
119          <th>ER_INVALID_TASK_STEP</th>
120          <td>The current step ID was specified in task registration.</td>
121        </tr>
122        <tr>
123          <th>ER_INVALID_PROPERTYTYPE</th>
124          <td>The property type is not supported.</td>
125        </tr>
126        <tr>
127          <th>ER_INVALID_URL</th>
128          <td>The URL string pointer is <CODE>NULL</CODE> or a zero-length string.</td>
129        </tr>
130        <tr>
131          <th>ER_INVALID_FILEPATH</th>
132          <td>The file path string pointer is <CODE>NULL</CODE> or a zero-length string.</td>
133        </tr>
134        <tr>
135          <th>ER_INVALID_TASK_PRIOLITY</th>
136          <td>The task priority specified is invalid.</td>
137        </tr>
138        <tr>
139          <th>ER_INVALID_TASK_TARGETDURATION</th>
140          <td>The task duration is invalid.</td>
141        </tr>
142        <tr>
143          <th>ER_ACTIONCODE_OUT_OF_RANGE</th>
144          <td>The task action code is invalid.</td>
145        </tr>
146        <tr>
147          <th>ER_INVALID_NSDATA_SEEK_POSITION</th>
148          <td>The NSDATA seek position exceeds the data size.</td>
149        </tr>
150        <tr>
151          <th>ER_INVALID_MAX_HTTP_REQUEST_HEADER</th>
152          <td>The HTTP request header registration count exceeds the maximum.</td>
153        </tr>
154        <tr>
155          <th>ER_INVALID_MAX_CLIENT_CERT</th>
156          <td>The client certificate exceeds the maximum setting value.</td>
157        </tr>
158        <tr>
159          <th>ER_INVALID_MAX_ROOT_CA</th>
160          <td>The root CA exceeds the maximum setting value.</td>
161        </tr>
162        <tr>
163          <th>ER_SCHEDULING_POLICY_OUT_OF_RANGE</th>
164          <td>The scheduling policy is invalid.</td>
165        </tr>
166        <tr>
167          <th>ER_APINFOTYPE_OUT_OF_RANGE</th>
168          <td>The AP information type is invalid.</td>
169        </tr>
170        <tr>
171          <th>ER_TASK_PERMISSION_OUT_OF_RANGE</th>
172          <td>The task permission information is invalid.</td>
173        </tr>
174        <tr>
175          <th>ER_WAITFINISH_TIMEOUT</th>
176          <td>The <CODE>WAITFINISH</CODE> timeout.</td>
177        </tr>
178        <tr>
179          <th>ER_WAITFINISH_TASK_NOT_DONE</th>
180          <td>The <CODE>WAITFINISH</CODE> task completed in a state other than <CODE>DONE</CODE>.</td>
181        </tr>
182        <tr>
183          <th>ER_IPC_NOT_SESSION_INITIALIZED</th>
184          <td>The IPC session is not initialized. (May be due to permissions not being applied)</td>
185        </tr>
186        <tr>
187          <th>ER_IPC_PROPERTY_SIZE_ERROR</th>
188          <td>IPC property size error.</td>
189        </tr>
190        <tr>
191          <th>ER_IPC_TOO_MANY_REQUESTS</th>
192          <td>Too many IPC requests.</td>
193        </tr>
194        <tr>
195          <th>ER_ALREADY_INITIALIZED</th>
196          <td>Initialization complete.</td>
197        </tr>
198        <tr>
199          <th>ER_OUT_OF_MEMORY</th>
200          <td>Insufficient memory.</td>
201        </tr>
202        <tr>
203          <th>ER_INVALID_NUMBER_OF_NSD</th>
204          <td>The number of NSDs in the NSA exceeds the maximum.</td>
205        </tr>
206        <tr>
207          <th>ER_NSDATA_INVALID_FORMAT</th>
208          <td>The NSD data format is invalid.</td>
209        </tr>
210        <tr>
211          <th>ER_APLI_NOT_EXIST</th>
212          <td>The specified application was not found.</td>
213        </tr>
214        <tr>
215          <th>ER_TASK_NOT_EXIST</th>
216          <td>The specified task ID was not found.</td>
217        </tr>
218        <tr>
219          <th>ER_TASK_STEP_NOT_EXIST</th>
220          <td>Specified task step was not found.</td>
221        </tr>
222        <tr>
223          <th>ER_APLI_ID_ALREADY_EXIST</th>
224          <td>Another application of the same name is already registered.</td>
225        </tr>
226        <tr>
227          <th>ER_TASK_ID_ALREADY_EXIST</th>
228          <td>Another task of the same name is already registered.</td>
229        </tr>
230        <tr>
231          <th>ER_TASK_STEP_ALREADY_EXIST</th>
232          <td>Another task step of the same name is already registered.</td>
233        </tr>
234        <tr>
235          <th>ER_INVALID_SEQUENCE</th>
236          <td>Sequence error (such as starting a task that is already running).</td>
237        </tr>
238        <tr>
239          <th>ER_DATABASE_FULL</th>
240          <td>The maximum number of applications and/or tasks has been registered, and no more storage or tasks can be registered.</td>
241        </tr>
242        <tr>
243          <th>ER_CANT_UNREGISTER_TASK</th>
244          <td><CODE>UnregisterTask</CODE> cannot be called due to the task state.</td>
245        </tr>
246        <tr>
247          <th>ER_TASK_NOT_REGISTED</th>
248          <td>No tasks (steps) have been registered to an SDB.</td>
249        </tr>
250        <tr>
251          <th>ER_INVALID_FILEHANDLE</th>
252          <td>Invalid file handle.</td>
253        </tr>
254        <tr>
255          <th>ER_INVALID_TASK_SCHEDULING_POLICY</th>
256          <td>Invalid scheduling policy.</td>
257        </tr>
258        <tr>
259          <th>ER_INVALID_HTTP_REQUEST_HEADER</th>
260          <td>HTTP request header error.</td>
261        </tr>
262        <tr>
263          <th>ER_INVALID_HEADTYPE</th>
264          <td>Invalid head type.</td>
265        </tr>
266        <tr>
267          <th>ER_STORAGE_ACCESSPERMISSION</th>
268          <td>No storage access permission.</td>
269        </tr>
270        <tr>
271          <th>ER_STORAGE_INSUFFICIENCY</th>
272          <td>Insufficient storage capacity.</td>
273        </tr>
274        <tr>
275          <th>ER_INVALID_APPID_STORAGE_NOTFOUND</th>
276          <td>There is no storage for the specified <CODE>APPID</CODE>.</td>
277        </tr>
278        <tr>
279          <th>ER_NSDATA_NOTFOUND</th>
280          <td>There is no NSD data.</td>
281        </tr>
282        <tr>
283          <th>ER_INVALID_NSDATA_GETHEAD_SIZE</th>
284          <td>The specified NSDATA <SPAN class="argument">SIZE</SPAN> parameter is invalid.</td>
285        </tr>
286        <tr>
287          <th>ER_NSDATA_LIST_SIZE_SHORTAGE</th>
288          <td>The <CODE>NsDataIdList</CODE> size is insufficient (the list is not big enough to store all the NSD serial IDs).</td>
289        </tr>
290        <tr>
291          <th>ER_NSDATA_LIST_UPDATED</th>
292          <td>The target NSD group for BOSS storage was updated since the last time a list was obtained.</td>
293        </tr>
294        <tr>
295          <th>ER_NOT_CONNECT_AP_WITH_LOCATION</th>
296          <td>Not connected to an access point.</td>
297        </tr>
298        <tr>
299          <th>ER_NOT_CONNECT_NETWORK</th>
300          <td>Not connected to a network.</td>
301        </tr>
302        <tr>
303          <th>ER_INVALID_FRIENDCODE</th>
304          <td>Invalid friend code error.</td>
305        </tr>
306        <tr>
307          <th>ER_FILE_ACCESS</th>
308          <td>File access failed.</td>
309        </tr>
310        <tr>
311          <th>ER_TASK_ALREADY_PAUSED</th>
312          <td>Already paused.</td>
313        </tr>
314        <tr>
315          <th>ER_TASK_ALREADY_RESUMED</th>
316          <td>Already resumed.</td>
317        </tr>
318        <tr>
319          <th>ER_UNEXPECT</th>
320          <td>Unexpected error.</td>
321        </tr>
322        <tr>
323          <th>RESULT_CODE_LAST</th>
324          <td>This value is not used.</td>
325        </tr>
326        <tr>
327          <th>RESULT_CODE_MAX_VALUE</th>
328          <td>
329        </td>
330        </tr>
331      </table> </div>
332    <h2>Description</h2>
333    <div class="section">
334      <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>
335    <h2>Revision History</h2>
336    <div class="section">
337      <dl class="history">
338        <dt>2010/09/16</dt>
339        <dd>Initial version.<br />
340        </dd>
341      </dl>
342    </div>
343  <hr><p>CONFIDENTIAL</p></body>
344</html>