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>WaitFinish</title>
8  </head>
9  <body>
10<h1><CODE>nn::boss::Task::WaitFinish</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> WaitFinish(
15const <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a> & timeout
16);
17</pre>
18    </div>
19<h2>Arguments</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>in</td>
31<th>timeout</th>
32<td>Specifies the timeout period.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<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 />
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>ResultSuccess</CODE></th>
46<td>The task finished with <span>TASK_DONE</span> or <span>TASK_ERROR</span>.</td>
47        </tr>
48        <tr>
49<th><CODE>ResultWaitFinishTaskNotDone</CODE></th>
50<td>The task was not started (it is in the <span>TASK_REGISTERED</span> state), or the task's execution was stopped (it is in the <span>TASK_STOPPED</span> state). Start the task again and wait for it to finish.  </td>
51        </tr>
52        <tr>
53<th><CODE>ResultWaitFinishTimeout</CODE></th>
54<td>The <CODE>WaitFinish</CODE> function timed out. Wait for the task to finish again. </td>
55        </tr>
56        <tr>
57<th><CODE>ResultInvalidTaskId</CODE></th>
58<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td>
59        </tr>
60        <tr>
61<th><CODE>ResultTaskNotExist</CODE></th>
62<td>The specified task ID was not found. Confirm whether it has already been registered.</td>
63        </tr>
64        <tr>
65<th><CODE>ResultIpcNotSessionInitialized</CODE></th>
66<td>Either the session had not been initialized or there were incompatible permissions. This <CODE>Result</CODE> value is returned if you call this function before <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> or <CODE>InitializePrivileged</CODE>. Always call <a href="../../../nn/boss/Task/Initialize.html"><CODE>Initialize</CODE></a> or <CODE>InitializePrivileged</CODE> first when you use the BOSS library.</td>
67        </tr>
68        <tr>
69<th>A value other than the above.</th>
70<td>Unexpected error (see <CODE>boss_Result.h</CODE> for details).</td>
71        </tr>
72      </table> </div>
73<h2>Description</h2>
74    <div class="section">
75<p>Waits for a task to finish within the specified time. This is the same as <a href="../../../nn/boss/Task/WaitFinish.html"><CODE>WaitFinish</CODE></a> except that it also has a timeout feature. If the timestamp indicating when the URL was modified is the same as the previous timestamp, the task downloads nothing and fails to complete. </p>
76    </div>
77  <hr><p>CONFIDENTIAL</p></body>
78</html>