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>GetTaskIdList</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/boss/Overview.html">boss</a>::GetTaskIdList</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> GetTaskIdList(
15     <a href="../../nn/boss/TaskIdList/Overview.html">TaskIdList</a> * pTaskIdList
16);
17</pre>
18    </div>
19<h2>Parameters</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>out</td>
31<th>pTaskIdList</th>
32<td>Specifies an object storing a list of task IDs.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the function's result. Returns one of the <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
37      <table class="arguments">
38        <thead>
39          <tr>
40<th>Value</th>
41<td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45<th><CODE>Result::IsSuccess</CODE></th>
46<td>Retrieval successful.</td>
47        </tr>
48        <tr>
49<th><CODE>ResultAppNotExist</CODE> </th>
50<td>There is no information on the calling application. Returns this error if the application has not run any tasks on BOSS or registered any BOSS storage.</td>
51        </tr>
52        <tr>
53<th><CODE>ResultInvalidTaskIdList</CODE></th>
54<td>The pointer for getting the task ID list is <CODE>NULL</CODE>.</td>
55        </tr>
56        <tr>
57<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
58<td>The session has not been initialized.<BR>This <CODE><a href="../../nn/Result/Overview.html">Result</a></CODE> is returned if this function is called before the <CODE><a href="../../nn/boss/Initialize.html">Initialize</A></CODE> function. Always call the <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> function before using the BOSS library.</td>
59        </tr>
60        <tr>
61<th>A value other than the above.</th>
62<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
63        </tr>
64      </table> </div>
65<h2>Description</h2>
66    <div class="section">
67<p>Gets a list of registered task IDs.</p><p>You must create an instance of the <a href="../../nn/boss/TaskIdList/Overview.html"><CODE>TaskIdList</CODE></a> class in advance.<br />Note that this instance requires approximately 1 KB of memory to get a list.</p><!-- write here --></div>
68<h2>Revision History</h2>
69    <div class="section">
70      <dl class="history">
71        <dt>2010/09/16</dt>
72<dd>Initial version.<br />
73        </dd>
74      </dl>
75    </div>
76  <hr><p>CONFIDENTIAL</p></body>
77</html>