Difference between revisions of "API System.EnableEvent"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Allows an event to be fired or removes the ability for an event to fire - this may be nested | Allows an event to be fired or removes the ability for an event to fire - this may be nested | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :System | ||
| + | ::EnableEvent | ||
| + | </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 13: | Line 19: | ||
:True to enable the event, false to disable | :True to enable the event, false to disable | ||
| − | + | ==Return value== | |
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">::System.EnableEvent(target, "msgname", false)</pre> |
Revision as of 21:15, 11 May 2013
<sidebar>API contents</sidebar> Allows an event to be fired or removes the ability for an event to fire - this may be nested
Class hierarchy
- System
- EnableEvent
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
BOOL Enable
- True to enable the event, false to disable
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::System.EnableEvent(target, "msgname", false)
