API System.ClaimEvent: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy=== | ===Class hierarchy===[[API |API ]] | ||
:System | :[[API System|System]] | ||
::ClaimEvent | ::ClaimEvent | ||
</div> | </div> | ||
Revision as of 21:20, 11 May 2013
<sidebar>API contents</sidebar> Claims an event message by name, returns true if claimed
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")