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>Wait</title>
8  </head>
9  <body>
10<h1><CODE>nn::os::Event::Wait</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/os.h&gt;
14
15bool Wait(
16     <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a> timeout
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>timeout</th>
33<td>Specifies the timeout period. Specifying 0 will cause control to return immediately.</td>
34        </tr> </table>
35    </div>
36<h2>Return Values</h2>
37<div class="section">Returns whether an event occurred within the timeout period. </div>
38<h2>Description</h2>
39    <div class="section">
40<p>Blocks until an event occurs.</p><p>Immediately returns <CODE>true</CODE> if an event is in the signaled state. If the event is not in the signaled state, this function waits for at most the length of time specified by <SPAN class="argument">timeout</SPAN>, and returns <CODE>true</CODE> if it receives a signal by then. Returns <CODE>false</CODE> if it does not receive a signal even after waiting for the time specified by <SPAN class="argument">timeout</SPAN>.</p></div>
41  <hr><p>CONFIDENTIAL</p></body>
42</html>