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>StartImmediate</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::Task::StartImmediate</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> StartImmediate(
15     void
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21<p>None.</p>
22    </div>
23<h2>Return Values</h2>
24<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 />
25      <table class="arguments">
26        <thead>
27          <tr>
28<th>Value</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<th><CODE>ResultSuccess</CODE></th>
34<td>Successfully issued instruction to start task immediately.</td>
35        </tr>
36        <tr>
37<th><CODE>ResultInvalidTaskId</CODE></th>
38<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
39        </tr>
40        <tr>
41<th><CODE>ResultTaskNotExist</CODE></th>
42<td>The specified task ID was not found. Confirm whether it is registered yet.</td>
43        </tr>
44        <tr>
45<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
46<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/Task/Initialize.html"><CODE>Initialize</CODE></a> or <CODE>InitializePrivileged</CODE> function first when you use the BOSS library.</td>
47        </tr>
48        <tr>
49<th>A value other than the above.</th>
50<td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td>
51        </tr>
52      </table> </div>
53<h2>Description</h2>
54    <div class="section">
55<p>Starts a task immediately. This can only be called after infrastructure connections are enabled. Because this allows a task to be executed before its scheduled time, it is suitable for as-needed immediate execution of tasks that would normally run in the background. When you specify immediate execution, you can run a task at the highest priority even if it means interrupting other running tasks. The <a href="../../../nn/boss/Task/Start.html"><CODE>Start</CODE></a> function differs from this one in that its execution time has already arrived and, if communications are interrupted, it does not enter the &quot;resume&quot; state but instead gives an error for the task execution result. Another point to note is that when you want to execute only the target task and only once, you must set its execution count to <CODE>1</CODE>. Setting it to a value more than <CODE>1</CODE> will cause it to auto-run in the background like a normal task until its execution count reaches zero. See <a href="../../../nn/ac/CTR/Connect.html"><CODE>ac::Connect</CODE></a> for information about how to enable infrastructure connections.</p><!-- write here --></div>
56<h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2010/09/16</dt>
60<dd>Initial version.<br />
61        </dd>
62      </dl>
63    </div>
64  <hr><p>CONFIDENTIAL</p></body>
65</html>