API System.ClaimEvent: Difference between revisions
XML import |
XML import |
||
| Line 15: | Line 15: | ||
[[Variable types|STRING]] ''MsgName'' | [[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== | ||
| Line 20: | Line 21: | ||
Returns true if claimed | Returns true if claimed | ||
==Detailed description== | ==Detailed description== | ||
Revision as of 01:56, 12 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")
No additional information