API System.ClaimEvent: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| 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 | ||
Revision as of 11:09, 10 June 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")
No additional information