Difference between revisions of "API System.WDTEnable"
From Flowcode Help
Jump to navigationJump to search (XML import of API routines for release) |
|||
| Line 21: | Line 21: | ||
==Detailed description== | ==Detailed description== | ||
| − | '' | + | This disables the software watchdog timer (SWWDT) for long operations, preventing the 'An operation is taking a long time to complete' message from popping up if an algorithm takes a long time. |
| + | |||
| + | |||
| + | Note this call will only take effect inside an event, and the results will only be applicable for the duration of that event. This means a component can not permanently disable the watchdog. | ||
| + | |||
| + | |||
| + | Nevertheless, for clean usage a flowchart should always re-enable the SWWDT with ''Enable'' set to true for every disable call made. This call may be nested and a disable count is maintained. | ||
| + | |||
Revision as of 08:18, 18 September 2013
<sidebar>API Contents</sidebar>
Enables or disables the software watchdog during long operations
Contents
Parameters
BOOL Enable
- Set true to enable, false to disable
Return value
This call does not return a value
Detailed description
This disables the software watchdog timer (SWWDT) for long operations, preventing the 'An operation is taking a long time to complete' message from popping up if an algorithm takes a long time.
Note this call will only take effect inside an event, and the results will only be applicable for the duration of that event. This means a component can not permanently disable the watchdog.
Nevertheless, for clean usage a flowchart should always re-enable the SWWDT with Enable set to true for every disable call made. This call may be nested and a disable count is maintained.
Examples
Calling in a calculation
- Add to a calculation icon:
::System.WDTEnable(false)
No additional examples
