1 |
schoenebeck |
2732 |
<html> |
2 |
|
|
<head> |
3 |
|
|
<meta name="author" content="Christian Schoenebeck"> |
4 |
|
|
<title>delete_event_mark() function</title> |
5 |
|
|
<meta name="description" content="Removes an event from some event group."> |
6 |
|
|
</head> |
7 |
|
|
<body> |
8 |
|
|
<h1>delete_event_mark()</h1> |
9 |
|
|
<p> |
10 |
|
|
Removes the supplied event from the requested event group, which had |
11 |
|
|
previously been added to that group by calling |
12 |
schoenebeck |
2742 |
<code lang="nksp">set_event_mark()</code>. |
13 |
schoenebeck |
2732 |
</p> |
14 |
|
|
|
15 |
|
|
<h3>Function Prototype</h3> |
16 |
|
|
<p/> |
17 |
|
|
<code> |
18 |
|
|
delete_event_mark(??event-id??, ??group-id??) |
19 |
|
|
</code> |
20 |
|
|
|
21 |
|
|
<h3>Arguments</h3> |
22 |
|
|
<table> |
23 |
|
|
<tr> |
24 |
|
|
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
25 |
|
|
</tr> |
26 |
|
|
<tr> |
27 |
|
|
<td><code>??event-id??</code></td> |
28 |
|
|
<td>Event ID Number</td> |
29 |
|
|
<td>Event to be removed from the group.<br> |
30 |
|
|
[required]</td> |
31 |
|
|
</tr> |
32 |
|
|
<tr> |
33 |
|
|
<td><code>??group-id??</code></td> |
34 |
|
|
<td>Event Group ID Number</td> |
35 |
|
|
<td>Event group where the event shall be removed from. You should pass one |
36 |
|
|
of the built-in constant variables <code>$MARK_1</code> to |
37 |
|
|
<code>$MARK_28</code> for this argument to select one of the |
38 |
|
|
28 available groups.<br> |
39 |
|
|
[required]</td> |
40 |
|
|
</tr> |
41 |
|
|
</table> |
42 |
|
|
|
43 |
|
|
<h3>Return Value</h3> |
44 |
|
|
<p>None.</p> |
45 |
|
|
|
46 |
|
|
<h3>Examples</h3> |
47 |
|
|
<p> |
48 |
|
|
None yet. |
49 |
|
|
</p> |
50 |
|
|
|
51 |
|
|
</body> |
52 |
|
|
</html> |