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>GetError</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/boss/Overview.html">boss</a>::<a href="../../../nn/boss/Task/Overview.html">Task</a>::GetError</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> GetError(
15     <a href="../../../nn/boss/TaskError/Overview.html">TaskError</a> * pTaskError,
16     <a href="../../../nn_types/u8.html">u8</a> * pStepId = NULL,
17     <a href="../../../nn_types/u8.html">u8</a> taskStep = CURRENT_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>out</td>
33<th>pTaskError</th>
34<td>Returns the task error state.</td>
35        </tr>
36        <tr>
37<td>out</td>
38<th><CODE>pStepId</CODE></th>
39<td>Returns the task step ID.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>taskStep</th>
44<td>Specifies a task step ID. (Defaults to the current step if omitted.)</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<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 />
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>Retrieval successful.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultInvalidTaskError</CODE></th>
62<td>The pointer to the task error information is <CODE>NULL</CODE>.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultInvalidTaskId</CODE></th>
66<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
67        </tr>
68        <tr>
69<th><CODE>ResultTaskNotExist</CODE></th>
70<td>The specified task ID was not found. Confirm whether it is registered yet.</td>
71        </tr>
72        <tr>
73<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
74<td>The session has not been initialized. This result is returned if this function is called before the <CODE><a href="../../../nn/boss/Task/Initialize.html">Initialize</A></CODE> function. Always call the <CODE>Initialize</CODE> function first thing when you use the BOSS library. </td>
75        </tr>
76        <tr>
77<th>A value other than the above.</th>
78<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
79        </tr>
80      </table> </div>
81<h2>Description</h2>
82    <div class="section">
83<p>Gets the task error state.</p><p>You must prepare a <a href="../../../nn/boss/TaskError/Overview.html"><CODE>TaskError</CODE></a> instance beforehand. Note that this instance requires approximately 136 bytes of memory.</p><!-- write here --></div>
84<h2>Revision History</h2>
85    <div class="section">
86      <dl class="history">
87        <dt>2010/09/16</dt>
88<dd>Initial version.<br />
89        </dd>
90      </dl>
91    </div>
92  <hr><p>CONFIDENTIAL</p></body>
93</html>