API System.ClaimEvent

From Flowcode Help
Revision as of 09:57, 17 June 2013 by JonnyW (talk | contribs) (XML import of updated API docs)
Jump to navigationJump to search


<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