Difference between revisions of "API System.ClaimEvent"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 19: Line 19:
 
==Return value==
 
==Return value==
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
 
 
Returns true if claimed
 
Returns true if claimed
  

Revision as of 21:55, 12 May 2013

<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 information