API System.ClaimEvent

From Flowcode Help
Revision as of 15:35, 10 May 2013 by Admin (talk | contribs) (XML import API auto-gen)
Jump to navigationJump to search

<sidebar>API contents</sidebar> 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

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")
Retrieved from "https://www.matrixtsl.com/wiki/index.php?title=API_System.ClaimEvent&oldid=943"