Difference between revisions of "API System.ClaimEvent"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Claims an event message by name, returns true if claimed | Claims an event message by name, returns true if claimed | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :System | ||
| + | ::ClaimEvent | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] Target'' | ''[[Variable types|HANDLE]] Target'' | ||
:The component that would usually recieve the event | :The component that would usually recieve the event | ||
| Line 10: | Line 16: | ||
:The quoted class.name formatted name of the event to claim | :The quoted class.name formatted name of the event to claim | ||
| − | + | ==Return value== | |
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
Returns true if claimed | Returns true if claimed | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ClaimEvent(target, "msgname")</pre> |
Revision as of 21:14, 11 May 2013
<sidebar>API contents</sidebar> Claims an event message by name, returns true if claimed
Class hierarchy
- System
- ClaimEvent
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")
