Difference between revisions of "API System.ReleaseEvent"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 15: Line 15:
 
[[Variable types|STRING]] ''MsgName''
 
[[Variable types|STRING]] ''MsgName''
 
:The quoted class.name formatted name of the event to release
 
:The quoted class.name formatted name of the event to release
 +
  
 
==Return value==
 
==Return value==
Line 20: Line 21:
  
 
Returns true if released
 
Returns true if released
 +
  
 
==Detailed description==
 
==Detailed description==

Revision as of 01:56, 12 May 2013

<sidebar>API contents</sidebar> Releases a previously claimed an event message by name, returns true if released

Class hierarchy

System

ReleaseEvent

Parameters

HANDLE Target

The component that would usually recieve the event

STRING MsgName

The quoted class.name formatted name of the event to release


Return value

BOOL

Returns true if released


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::System.ReleaseEvent(target, "msgname")

No additional information