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>nn::boss::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,
16u8 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. (May be omitted if there is only one task step to be executed)</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>ResultSuccess</CODE></th>
52<td>Deletion successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultInvalidTaskId</CODE></th>
56<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
57        </tr>
58        <tr>
59<th><CODE>ResultTaskNotExist</CODE></th>
60<td>The specified task ID was not found. Confirm whether it has already been registered.</td>
61        </tr>
62        <tr>
63<th><CODE>ResultCantUnregisterTask</CODE></th>
64<td>The task cannot be deleted because of its state. (For example, it may currently be running or have already been scheduled.) Call the Cancel() method of the <a href="../../nn/boss/Task/Overview.html">Task</a>, and then try to delete it. </td>
65        </tr>
66        <tr>
67<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
68<td>Either a session had not been initialized or there were incompatible permissions. This <CODE>Result</CODE> value is returned if you call this function before <a href="../../../nn/boss/Task/Initialize.html"><CODE>Initialize</CODE></a> or <CODE>InitializePrivileged</CODE>. Always call <a href="../../../nn/boss/Task/Initialize.html"><CODE>Initialize</CODE></a> or <CODE>InitializePrivileged</CODE> first when you use the BOSS library.</td>
69        </tr>
70        <tr>
71<th>A value other than the above.</th>
72<td>Unexpected error (see <CODE>boss_Result.h</CODE> for details).</td>
73        </tr>
74      </table> </div>
75<h2>Description</h2>
76    <div class="section">
77<p>Unregisters a task previously registered to the library. Because you cannot delete tasks that are waiting to run or that are currently running, call the <a href="../../nn/boss/Task/Overview.html"><CODE>Task</CODE></a> class's <CODE>Cancel</CODE> function beforehand as necessary.</p><!-- write here --></div>
78<h2>Revision History</h2>
79    <div class="section">
80      <dl class="history">
81        <dt>2010/09/16</dt>
82<dd>Initial version.<br />
83        </dd>
84      </dl>
85    </div>
86  <hr><p>CONFIDENTIAL</p></body>
87</html>