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>GetStepIdList</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::GetStepIdList</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> GetStepIdList(
15     const char * pTaskId,
16     <a href="../../nn/boss/StepIdList/Overview.html">StepIdList</a> * pStepIdList
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th><CODE>pTaskId</CODE></th>
33<td>Specifies a registered task.</td>
34        </tr>
35        <tr>
36<td>out</td>
37<th>pStepIdList</th>
38<td>Specifies an object storing a list of task step IDs.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the function's execution result. Returns one of the <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></A></a> values listed below. <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>ResultSuccess</CODE></th>
52<td>Retrieval successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultInvalidTaskId</CODE></th>
56<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
57        </tr>
58        <tr>
59<th><CODE>ResultInvalidStepIdList</CODE></th>
60<td>The pointer for getting the step ID list is <CODE>NULL</CODE>.</td>
61        </tr>
62        <tr>
63<th><CODE>ResultAppNotExist</CODE></th>
64<td>Occurs when neither the task, the storage, nor the private certificate are registered.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultTaskNotExist</CODE></th>
68<td>The specified task ID was not found.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
72<td>Either the session is not initialized or there are incompatible permissions. This <CODE>Result</CODE> is returned if this function is called before the <a href="../../../nn/boss/Task/Initialize.html"><CODE>Initialize</CODE></A> or <CODE>InitializePrivileged</CODE> function. Always call the <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> or <CODE>InitializePrivileged</CODE> function first when you use the BOSS library.</td>
73        </tr>
74        <tr>
75<th>A value other than the above.</th>
76<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
77        </tr>
78      </table> </div>
79<h2>Description</h2>
80    <div class="section">
81<p>Gets a list of all steps for the specified registered task.</p><p>You must create an instance of the <a href="../../nn/boss/StepIdList/Overview.html"><CODE>StepIdList</CODE></a> class in advance. Note that this instance requires approximately 256 bytes of memory to get a list.</p><!-- write here --></div>
82<h2>Revision History</h2>
83    <div class="section">
84      <dl class="history">
85        <dt>2010/09/16</dt>
86<dd>Initial version.<br />
87        </dd>
88      </dl>
89    </div>
90  <hr><p>CONFIDENTIAL</p></body>
91</html>
92