reference/functions/nksp_stop_wait_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>stop_wait() function</title>
    <meta name="description" content="Resumes execution of a suspended script callback.">
  </head>
  <body>
    <h1>stop_wait()</h1>
    <p>
      Resumes execution of a script event handler instance currently being
      paused due to a <code lang="nksp">wait()</code> call. You need to
      pass the callback ID of the event handler instance to be resumed to
      this function. For the same event type there may be more than
      one event handler instances running. Each one of them has its own
      callback ID. You can get the current event handler instance's callback
      ID by reading the built-in variable <code>$NI_CALLBACK_ID</code>.
    </p>
    
    <h3>Function Prototype</h3>
    <p/>
    <code lang="nksp">
stop_wait(??callback-id??, [??flags??])
    </code>

    <h3>Arguments</h3>
    <table>
      <tr>
        <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
      </tr>
      <tr>
        <td><code>??callback-id??</code></td>
        <td>Callback ID</td>
        <td>Event handler instance to be resumed.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??flags??</code></td>
        <td>Integer Number</td>
        <td>Additional options:<br>
            <code>0</code>: No additional option. Just resume the requested currently
               suspended event handler instance.<br>
            <code>1</code>: Not only resume the currently suspended event handler
               instance, but also let it ignore all subsequent
               <code>wait()</code> calls. Be very careful when using this option!
               The resumed handler's built-in variable <code>$NKSP_IGNORE_WAIT</code>
               will reflect <code>1</code> after this call. So the resumed script
               may read this variable to act accordingly.<br>
            [optional, default: <code>0</code>]</td>
      </tr>
    </table>
    
    <h3>Return Value</h3>
    <p>None.</p>
    
    <h3>Examples</h3>
    <p>None yet.</p>

    <h3>See also</h3>
    <p><code>wait()</code><p>

    <h3>Availability</h3>
    <p>Since LinuxSampler 2.0.0.svn17.<p>

  </body>
</html>
1	<html>
2	<head>
3	<meta name="author" content="Christian Schoenebeck">
4	<title>stop_wait() function</title>
5	<meta name="description" content="Resumes execution of a suspended script callback.">
6	</head>
7	<body>
8	<h1>stop_wait()</h1>
9	<p>
10	Resumes execution of a script event handler instance currently being
11	paused due to a <code lang="nksp">wait()</code> call. You need to
12	pass the callback ID of the event handler instance to be resumed to
13	this function. For the same event type there may be more than
14	one event handler instances running. Each one of them has its own
15	callback ID. You can get the current event handler instance's callback
16	ID by reading the built-in variable <code>$NI_CALLBACK_ID</code>.
17	</p>
18
19	<h3>Function Prototype</h3>
20	<p/>
21	<code lang="nksp">
22	stop_wait(??callback-id??, [??flags??])
23	</code>
24
25	<h3>Arguments</h3>
26	<table>
27	<tr>
28	<th>Argument Name</th> <th>Data Type</th> <th>Description</th>
29	</tr>
30	<tr>
31	<td><code>??callback-id??</code></td>
32	<td>Callback ID</td>
33	<td>Event handler instance to be resumed.<br>
34	[required]</td>
35	</tr>
36	<tr>
37	<td><code>??flags??</code></td>
38	<td>Integer Number</td>
39	<td>Additional options:<br>
40	<code>0</code>: No additional option. Just resume the requested currently
41	suspended event handler instance.<br>
42	<code>1</code>: Not only resume the currently suspended event handler
43	instance, but also let it ignore all subsequent
44	<code>wait()</code> calls. Be very careful when using this option!
45	The resumed handler's built-in variable <code>$NKSP_IGNORE_WAIT</code>
46	will reflect <code>1</code> after this call. So the resumed script
47	may read this variable to act accordingly.<br>
48	[optional, default: <code>0</code>]</td>
49	</tr>
50	</table>
51
52	<h3>Return Value</h3>
53	<p>None.</p>
54
55	<h3>Examples</h3>
56	<p>None yet.</p>
57
58	<h3>See also</h3>
59	<p><code>wait()</code><p>
60
61	<h3>Availability</h3>
62	<p>Since LinuxSampler 2.0.0.svn17.<p>
63
64	</body>
65	</html>