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>GetState</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::Task::GetState</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/boss/TaskStateCode.html">TaskStateCode</a> GetState(
15     bool acknowledge = false,
16     u32 * pCount = NULL,
17     u8 * pStepID = NULL
18);
19</pre>
20    </div>
21<h2>Arguments</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>acknowledge</th>
34<td>Stores the &quot;execution complete&quot; status once a task finishes execution so that the execution results can be checked. 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 return value to switch to <CODE>TASK_WAITING_TIMER</CODE> the next time the function is called. (Optional.)</td>
35        </tr>
36        <tr>
37<td>out</td>
38<th>pCount</th>
39<td>Returns the execution count. (Optional.)</td>
40        </tr>
41        <tr>
42<td>out</td>
43<th>pStepID</th>
44<td>Returns the task step ID. (Optional.)</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns a code indicating the task state. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Gets the task state. In most cases, tasks transition from step 1 through 5 below. <br />(1) <CODE>TASK_REGISTERED</CODE> (task registered)<br />(2) <CODE>TASK_WAITING_TIMER</CODE> (waiting for time after <CODE>Start</CODE> function is called)<br />(3) <CODE>TASK_WAITING</CODE> (waiting for execution)<br />(4) <CODE>TASK_RUNNING</CODE> or <CODE>TASK_RETRY</CODE> (task is running)<br />(5) <CODE>TASK_DONE</CODE> or <CODE>TASK_ERROR</CODE> (task is complete)<br /><br />There are also two special states, <CODE>TASK_PAUSED</CODE> (paused) and <CODE>TASK_STOPPED</CODE> (stopped due to a call to <CODE>Cancel</CODE>). State transitions may occur in a short period of time. Accordingly, the function may not always return all states. </p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/09/16</dt>
56<dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>
62