Difference between revisions of "API System.ClaimEvent"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
(XML import)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
+
<sidebar>API Contents</sidebar>
 
 
<sidebar>API contents</sidebar>
 
 
Claims an event message by name, returns true if claimed
 
Claims an event message by name, returns true if claimed
  

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Claims an event message by name, returns true if claimed

Class hierarchy

System

ClaimEvent

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

BOOL

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