Difference between revisions of "API System.ClaimEvent"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
(XML import of updated API docs) |
||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Claims an event message by name, returns true if claimed | Claims an event message by name, returns true if claimed | ||
| Line 32: | Line 34: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ClaimEvent(target, "msgname")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ClaimEvent(target, "msgname")</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Revision as of 09:57, 17 June 2013
<sidebar>API contents</sidebar>
Claims an event message by name, returns true if claimed
Contents
Parameters
HANDLE Target
- The component that would usually recieve the event
STRING MsgName
- The quoted class.name formatted name of the event to claim
Return value
Returns true if claimed
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::System.ClaimEvent(target, "msgname")
No additional examples
