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>GetStateDetail</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::Task::GetStateDetail</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> GetStateDetail(
15<a href="../../../nn/boss/TaskStatus/Overview.html">TaskStatus</a> * pStatus,
16bool acknowledge = false,
17u8 * pStepID = NULL,
18u8 taskStep = CURRENT_STEP_ID
19);
20</pre>
21    </div>
22<h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>out</td>
34<th>pStatus</th>
35<td>Returns the task status.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>acknowledge</th>
40<td>To allow confirmation of execution results, once the task finishes running, this argument stores a <a href="../../../nn/boss/TaskStatus/Overview.html"><CODE>TaskStateCode</CODE></a> from the <a href="../../../nn/boss/TaskStatus/Overview.html"><CODE>TaskStatus</CODE></a> object, indicating that task execution is complete. Calling the function with this flag set to <CODE>true</CODE> clears the &quot;execution complete&quot; status. Tasks whose execution counts are non-zero are rescheduled immediately after the previous task execution completes. This causes the state to switch to <CODE>TASK_WAITING_TIMER</CODE> for the next call. (Optional)</td>
41        </tr>
42        <tr>
43<td>out</td>
44<th>pStepID</th>
45<td>Returns the task step ID.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>taskStep</th>
50<td>Specifies a task step ID. (Defaults to the current step if omitted.)</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<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 />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>ResultSuccess</CODE></th>
64<td>Reset state obtained successfully.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultInvalidTaskStatus</CODE></th>
68<td>The task status pointer is <CODE>NULL</CODE>.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultInvalidTaskId</CODE></th>
72<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultTaskNotExist</CODE></th>
76<td>The specified task ID was not found. Confirm whether registered.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
80<td>Either a session had not been initialized or there were incompatible permissions. This <CODE>Result</CODE> is returned if this function is called before either the <A><CODE>Initialize</CODE></A> or the <CODE>InitializePriviledged</CODE> function is called. When using the BOSS library, always begin by calling either the <A><CODE>Initialize</CODE></A> or the <CODE>InitializePriviledged</CODE> function.</td>
81        </tr>
82        <tr>
83<th>A value other than the above.</th>
84<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
85        </tr>
86      </table> </div>
87<h2>Description</h2>
88    <div class="section">
89<p>Gets the task status. You must prepare a <a href="../../../nn/boss/TaskStatus/Overview.html"><CODE>TaskStatus</CODE></a> instance beforehand. Note that this instance requires approximately 128 bytes of memory. See the <CODE>GetProperty</CODE> member function of the <a href="../../../nn/boss/TaskStatus/Overview.html"><CODE>TaskStatus</CODE></a> class for more information about obtaining the values of the attributes.</p><!-- write here --></div>
90<h2>Revision History</h2>
91    <div class="section">
92      <dl class="history">
93        <dt>2010/11/10</dt>
94<dd>Initial version.<br />
95        </dd>
96      </dl>
97    </div>
98  <hr><p>CONFIDENTIAL</p></body>
99</html>