Difference between revisions of "API System.ClaimEvent"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
(XML import of API documentation) |
||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Claims an event message by name, returns true if claimed | Claims an event message by name, returns true if claimed | ||
Revision as of 14:27, 9 August 2013
<sidebar>API Contents</sidebar>
Claims an event message by name, returns true if claimed
Contents
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 examples