reference/functions/nksp_abort_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>abort() function</title>
    <meta name="description" content="Stops execution of a script callback.">
  </head>
  <body>
    <h1>abort()</h1>
    <p>
      You may call this function to stop execution of an arbitrary event
      handler instance. You need to pass the callback ID of the event
      handler instance to be stopped as argument 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 unique 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">
abort(??callback-id??)
    </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 stopped.<br>
            [required]</td>
      </tr>
    </table>
    
    <h3>Return Value</h3>
    <p>None.</p>

    <h3>Examples</h3>
    <p>None yet.</p>

    <h3>See also</h3>
    <p><code>stop_wait()</code>, <code>exit()</code>, <code>fork()</code>, <code>callback_status()</code><p>

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

    <note>
      This function is only available with NKSP, it does not exist with KSP.
    </note>

  </body>
</html>
1	schoenebeck	3278	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>abort() function</title>
5			<meta name="description" content="Stops execution of a script callback.">
6			</head>
7			<body>
8			<h1>abort()</h1>
9			<p>
10			You may call this function to stop execution of an arbitrary event
11			handler instance. You need to pass the callback ID of the event
12			handler instance to be stopped as argument to this function.
13			For the same event type there may be more than one event handler
14			instances running. Each one of them has its own unique callback ID.
15			You can get the current event handler instance's callback ID by reading
16			the built-in variable <code>$NI_CALLBACK_ID</code>.
17			</p>
18
19			<h3>Function Prototype</h3>
20			<p/>
21			<code lang="nksp">
22			abort(??callback-id??)
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 stopped.<br>
34			[required]</td>
35			</tr>
36			</table>
37
38			<h3>Return Value</h3>
39			<p>None.</p>
40
41			<h3>Examples</h3>
42			<p>None yet.</p>
43
44			<h3>See also</h3>
45	schoenebeck	3297	<p><code>stop_wait()</code>, <code>exit()</code>, <code>fork()</code>, <code>callback_status()</code><p>
46	schoenebeck	3278
47			<h3>Availability</h3>
48			<p>Since LinuxSampler 2.0.0.svn61.<p>
49
50			<note>
51			This function is only available with NKSP, it does not exist with KSP.
52			</note>
53
54			</body>
55			</html>