API System.ClaimEvent: Difference between revisions
XML import of API auto-gen |
XML import API auto-gen |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
Claims an event message by name, returns true if claimed | |||
===Parameters=== | ===Parameters=== | ||
| Line 21: | Line 19: | ||
===Examples=== | ===Examples=== | ||
====Calling in a calculation | ====Calling in a calculation==== | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: result = ::System.ClaimEvent(target, "msgname") | * Add to a calculation icon: result = ::System.ClaimEvent(target, "msgname") | ||
Revision as of 15:34, 10 May 2013
wiki page name 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")