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>GetInfo</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>::GetInfo</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> GetInfo(
15     <a href="../../../nn/boss/TaskPolicy/Overview.html">TaskPolicy</a> * pPolicy,
16     <a href="../../../nn/boss/TaskAction/Overview.html">TaskAction</a> * pAction,
17     <a href="../../../nn/boss/TaskOption/Overview.html">TaskOption</a> * pOption,
18     <a href="../../../nn_types/u8.html">u8</a> taskStep = CURRENT_STEP_ID
19);
20</pre>
21    </div>
22<h2>Parameters</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>pPolicy</th>
35<td>Specifies a task policy.</td>
36        </tr>
37        <tr>
38<td>out</td>
39<th>pAction</th>
40<td>Specifies a task action.</td>
41        </tr>
42        <tr>
43<td>out</td>
44<th>pOption</th>
45<td>Specifies task options.</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>Result::IsSuccess</CODE></th>
64<td>Retrieval successful.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultInvalidTaskId</CODE></th>
68<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultInvalidPolicy</CODE></th>
72<td>The policy information pointer is <CODE>NULL</CODE>.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultInvalidAction</CODE></th>
76<td>The task action pointer is <CODE>NULL</CODE>.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultInvalidOption</CODE></th>
80<td>The task option pointer is <CODE>NULL</CODE>, or the option code is invalid.</td>
81        </tr>
82        <tr>
83<th><CODE>ResultTaskNotExist</CODE></th>
84<td>The specified task ID was not found. Confirm whether it is registered yet.</td>
85        </tr>
86        <tr>
87<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
88<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>
89        </tr>
90        <tr>
91<th>A value other than the above.</th>
92<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
93        </tr>
94      </table> </div>
95<h2>Description</h2>
96    <div class="section">
97<p>Gets information about a registered task.</p><p>You must prepare instances of the <a href="../../../nn/boss/TaskPolicy/Overview.html"><CODE>TaskPolicy</CODE></a>, <a href="../../../nn/boss/TaskAction/Overview.html"><CODE>TaskAction</CODE></a>, and <a href="../../../nn/boss/TaskOption/Overview.html"><CODE>TaskOption</CODE></a> classes beforehand. See the <CODE>GetProperty</CODE> member function of each class for more information about obtaining the values of the attributes.</p><!-- write here --></div>
98<h2>Revision History</h2>
99    <div class="section">
100      <dl class="history">
101        <dt>2010/09/16</dt>
102<dd>Initial version.<br />
103        </dd>
104      </dl>
105    </div>
106  <hr><p>CONFIDENTIAL</p></body>
107</html>