Difference between revisions of "API System.ReleaseEvent"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(13 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
Releases a previously claimed an event message by name, returns true if released | Releases a previously claimed an event message by name, returns true if released | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API System|System]] | ||
+ | :[[API System|ReleaseEvent]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Target'' | |
:The component that would usually recieve the event | :The component that would usually recieve the event | ||
− | + | [[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 | ||
− | + | ||
− | [[Variable | + | ==Return value== |
+ | [[Variable Types|BOOL]] | ||
Returns true if released | Returns true if released | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | ''<span style="color:red;">No additional information</span>'' | |
+ | |||
+ | |||
+ | ==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> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Releases a previously claimed an event message by name, returns true if released
Contents
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
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 examples