Difference between revisions of "API System.EnableEvent"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
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"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API System|System]] | + | ====Class hierarchy==== |
| + | [[API System|System]] | ||
:[[API System|EnableEvent]] | :[[API System|EnableEvent]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==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 Types|BOOL]] ''Enable'' | |
:True to enable the event, false to disable | :True to enable the event, false to disable | ||
| + | |||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::System.EnableEvent(target, "msgname", false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::System.EnableEvent(target, "msgname", false)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Allows an event to be fired or removes the ability for an event to fire - this may be nested
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)
No additional examples
