Jump to content

API System.ReleaseEvent: Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,422 edits
Admin (talk | contribs)
3,524 edits
XML import of API auto-gen
 
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
wiki page name
{| class="mtx-class-macrotable wikitable"
==SystemReleaseEvent==
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReleaseEvent'''
|-
| colspan="2" | Releases a previously claimed an event message by name, returns true if released 
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Target
|-
| colspan="2" | The component that would usually recieve the event 
|-
| 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 
|-
| 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''
|}


Releases a previously claimed an event message by name, returns true if released
----


===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
==Examples==
 
===Calling in a calculation===
===Detailed description===
''No additional information''
 
===Examples===
====Calling in a calculation:====
* Declare a variable 'result' of type BOOL
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: result = ::System.ReleaseEvent(target, "msgname")
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ReleaseEvent(target, "msgname")</pre>

Latest revision as of 14:11, 13 July 2026

ReleaseEvent
Releases a previously claimed an event message by name, returns true if released 
- HANDLE Target
The component that would usually recieve the event 
- STRING MsgName
The quoted class.name formatted name of the event to release 
- 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")
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_System.ReleaseEvent&oldid=43017"