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>ReconfigureTask</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/boss/Overview.html">boss</a>::ReconfigureTask</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> ReconfigureTask(
15     <a href="../../nn/boss/Task/Overview.html">Task</a> * pTask,
16     <a href="../../nn/boss/TaskPolicy/Overview.html">TaskPolicy</a> * pPolicy,
17     <a href="../../nn_types/u8.html">u8</a> taskStep = DEFAULT_STEP_ID
18);
19</pre>
20    </div>
21<h2>Parameters</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>in</td>
33<th>pTask</th>
34<td>Specifies a registered task.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>pPolicy</th>
39<td>Specifies a task policy that contains updated content.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>taskStep</th>
44<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>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the function's result. Returns one of the <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
49      <table class="arguments">
50        <thead>
51          <tr>
52<th>Value</th>
53<td>Description</td>
54          </tr>
55        </thead>
56        <tr>
57<th><CODE>Result::IsSuccess</CODE></th>
58<td>Successfully updated.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultInvalidTaskId</CODE></th>
62<td>The <SPAN class="argument">pTask</SPAN> parameter is <CODE>NULL</CODE>.<br />Alternatively, the <SPAN class="argument">pTask</SPAN> parameter is uninitialized, or the pointer of the task ID specified by <SPAN class="argument">pTask</SPAN> is <CODE>NULL</CODE> or a zero-length string.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultInvalidPolicy</CODE></th>
66<td>The <CODE>pPolicy</CODE> parameter is <CODE>NULL</CODE>.</td>
67        </tr>
68        <tr>
69<th>ResultInvalidTaskPriority</th>
70<td>The task execution priority specification is out of range. Confirm that it is in the range of <CODE><a href="../../nn/boss/TaskPriority.html">TaskPriority</a></CODE>.</td>
71        </tr>
72        <tr>
73<th><CODE>ResultTaskPermissionOutOfRange</CODE></th>
74<td>The task permission condition is out of range.<a href="../../nn/boss/TaskPermission.html">Confirm that it is in the range of <CODE><a href="../../nn/boss/TaskPermission.html">TaskPermission</a></CODE>.</td>
75        </tr>
76        <tr>
77<th><CODE>ResultSchedulingPolicyOutOfRange</CODE></th>
78<td>The scheduling policy is out of range. Confirm that it is in the range of <CODE><a href="../../nn/boss/SchedulingPolicy.html">SchedulingPolicy</a></CODE>.</td>
79        </tr>
80        <tr>
81<th><CODE>ResultInvalidTaskTargetDuration</CODE></th>
82<td>The task duration is invalid. (This is for future extensibility.)</td>
83        </tr>
84        <tr>
85<th><CODE>ResultTaskNotExist</CODE></th>
86<td>The specified task ID was not found. Confirm whether it is registered yet.</td>
87        </tr>
88        <tr>
89<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
90<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>
91        </tr>
92        <tr>
93<th>A value other than the above.</th>
94<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
95        </tr>
96      </table> </div>
97<h2>Description</h2>
98    <div class="section">
99<p>The property settings for registered tasks can be changed.</p><p>The properties that can be changed are only those that can be set using <a href="../../nn/boss/TaskPolicy/Overview.html">nn::boss::TaskPolicy</a>.</p><!-- write here --></div>
100<h2>Revision History</h2>
101    <div class="section">
102      <dl class="history">
103        <dt>2010/09/16</dt>
104<dd>Initial version.<br />
105        </dd>
106      </dl>
107    </div>
108  <hr><p>CONFIDENTIAL</p></body>
109</html>
110