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>UnregisterTask</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/boss/Overview.html">boss</a>::UnregisterTask</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14+<a href="../../nn/Result/Overview.html">nn::Result</a> UnregisterTask(
15     <a href="../../nn/boss/Task/Overview.html">Task</a> * pTask,
16     u8 taskStep = DEFAULT_STEP_ID
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>pTask</th>
33<td>Specifies a registered task.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>taskStep</th>
38<td>Specifies a task step ID. (Can be omitted if there is only one task execution step)<br /><B>Note</B>: This parameter is for a feature extension, and is currently not supported. Do not specify it.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<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 />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>Result::IsSuccess</CODE></th>
52<td>Deletion successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultInvalidTaskId</CODE></th>
56<td>The <SPAN class="argument">pTask</SPAN> argument is <CODE>NULL</CODE>.<br />Alternatively, the <SPAN class="argument">pTask</SPAN> argument is uninitialized, or the pointer of the task ID specified by <SPAN class="argument">pTask</SPAN> is <CODE>NULL</CODE> or an empty string.</td>
57        </tr>
58        <tr>
59<th><CODE>ResultTaskNotExist</CODE></th>
60<td>The specified task ID was not found. Confirm whether it is registered yet.</td>
61        </tr>
62        <tr>
63<th><CODE>ResultAppNotExist</CODE></th>
64<td>The specified task ID was not found.<br />(NADL task) This function returns this <CODE><a href="../../nn/Result/Overview.html">Result</a></CODE> when the BOSS storage has not yet been registered.<br />(Other than NADL task) This function returns this <CODE><a href="../../nn/Result/Overview.html">Result</a></CODE> when the task of the application that called it has never been registered.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultCantUnregisterTask</CODE></th>
68<td>The task cannot be deleted because of its state. (For example, it may currently be running or have already been scheduled.) Call <a href="../../nn/boss/Task/Cancel.html"><CODE>nn::boss::Task::Cancel</CODE></a> and then try again to delete the task.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
72<td>The session has not been initialized.<BR>This <CODE><a href="../../nn/Result/Overview.html">Result</a></CODE> is returned if this function is called before the <CODE><a href="../../nn/boss/Initialize.html">Initialize</A></CODE> function. Always call the <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> function before using the BOSS library.</td>
73        </tr>
74        <tr>
75<th>A value other than the above.</th>
76<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
77        </tr>
78      </table> </div>
79<h2>Description</h2>
80    <div class="section">
81<p>Deletes a registered task.</p><p>Although you can unregister a task that is currently running or is waiting to run, you will be unable to check that task's execution results. If you want to check the task's execution results, do so after the task has finished running, then call <CODE><a href="../../nn/boss/Task/Cancel.html">nn::boss::Task::Cancel</a></CODE> to prevent the next task from running, and unregister the task.</p><!-- write here --></div>
82<h2>Revision History</h2>
83    <div class="section">
84      <dl class="history">
85        <dt>2010/09/16</dt>
86<dd>Initial version.<br />
87        </dd>
88      </dl>
89    </div>
90  <hr><p>CONFIDENTIAL</p></body>
91</html>