Difference between revisions of "API System.ClaimEvent"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML import) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <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 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Target'' |
:The component that would usually recieve the event | :The component that would usually recieve the event | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''MsgName'' |
:The quoted class.name formatted name of the event to claim | :The quoted class.name formatted name of the event to claim | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|BOOL]] |
Returns true if claimed | Returns true if claimed | ||
| Line 32: | Line 32: | ||
* 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>'' |
Latest revision as of 15:57, 16 January 2014
<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
