API System.ClaimEvent: Difference between revisions
XML import API auto-gen |
XML import API auto-gen |
||
| Line 1: | Line 1: | ||
API contents | |||
Claims an event message by name, returns true if claimed | Claims an event message by name, returns true if claimed | ||
Revision as of 15:34, 10 May 2013
API contents 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")