Difference between revisions of "API System.ReleaseEvent"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Releases a previously claimed an event message by name, returns true if released
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReleaseEvent'''
 +
|-
 +
| colspan="2" | Releases a previously claimed an event message by name, returns true if released&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The component that would usually recieve the event&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | MsgName
 +
|-
 +
| colspan="2" | The quoted class.name formatted name of the event to release&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
===Class hierarchy===[[API System|System]]
 
:[[API System|ReleaseEvent]]
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
''[[Variable types|HANDLE]] Target''
 
:The component that would usually recieve the event
 
 
 
''[[Variable types|STRING]] MsgName''
 
:The quoted class.name formatted name of the event to release
 
 
 
==Return value==
 
[[Variable types|BOOL]]
 
  
Returns true if released
 
  
==Detailed description==
 
''No additional information''
 
  
 
==Examples==
 
==Examples==

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png ReleaseEvent
Releases a previously claimed an event message by name, returns true if released 
Fc9-h32-icon.png - HANDLE Target
The component that would usually recieve the event 
Fc9-string-icon.png - STRING MsgName
The quoted class.name formatted name of the event to release 
Fc9-bool-icon.png - BOOL Return


Detailed description

Examples

Calling in a calculation

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