1 |
<html> |
2 |
<head> |
3 |
<meta name="author" content="Christian Schoenebeck"> |
4 |
<title>by_marks() function</title> |
5 |
<meta name="description" content="Returns all events of an event group."> |
6 |
</head> |
7 |
<body> |
8 |
<h1>by_marks()</h1> |
9 |
<p> |
10 |
Returns an array of event IDs of all events being members of the requested event group. |
11 |
These are events which had previously been added to that event group |
12 |
by calling the <code>set_event_mark()</code> function. |
13 |
The <code>by_marks()</code> function acts as placeholder for all event |
14 |
IDs of the particular group and allows to manipulate a set of events |
15 |
this way with only one call. |
16 |
</p> |
17 |
|
18 |
<h3>Function Prototype</h3> |
19 |
<p/> |
20 |
<code> |
21 |
by_marks(??group-id??) |
22 |
</code> |
23 |
|
24 |
<h3>Arguments</h3> |
25 |
<table> |
26 |
<tr> |
27 |
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
28 |
</tr> |
29 |
<tr> |
30 |
<td><code>??group-id??</code></td> |
31 |
<td>Event Group ID Number</td> |
32 |
<td>Event group that shall be referenced. You should pass one |
33 |
of the built-in constant variables <code>$MARK_1</code> to |
34 |
<code>$MARK_28</code> for this argument to select one of the |
35 |
28 available groups.<br> |
36 |
[required]</td> |
37 |
</tr> |
38 |
</table> |
39 |
|
40 |
<h3>Return Value</h3> |
41 |
<p>None.</p> |
42 |
|
43 |
<h3>Examples</h3> |
44 |
<code> |
45 |
on note |
46 |
if ($EVENT_NOTE < 36) |
47 |
set_event_mark($EVENT_ID, $MARK_1) |
48 |
note_off(by_marks($MARK_2)) |
49 |
else |
50 |
set_event_mark($EVENT_ID, $MARK_2) |
51 |
note_off(by_marks($MARK_1)) |
52 |
end if |
53 |
end on |
54 |
</code> |
55 |
|
56 |
</body> |
57 |
</html> |