API System.ReleaseEvent: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
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=== | |||
:System | |||
::ReleaseEvent | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Target'' | ''[[Variable types|HANDLE]] Target'' | ||
:The component that would usually recieve the event | :The component that would usually recieve the event | ||
| Line 10: | Line 16: | ||
:The quoted class.name formatted name of the event to release | :The quoted class.name formatted name of the event to release | ||
==Return value== | |||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
Returns true if released | Returns true if released | ||
==Detailed description== | |||
''No additional information'' | ''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: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ReleaseEvent(target, "msgname")</pre> | ||
Revision as of 21:15, 11 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
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")