Difference between revisions of "API System.ReleaseEvent"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | == | + | |- |
| + | | 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 | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | === | + | ==Detailed description== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ==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 11:55, 16 January 2023
|
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")
