Difference between revisions of "API System.WDTEnable"
From Flowcode Help
Jump to navigationJump to search (XML import of API routines for release) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WDTEnable''' | ||
| + | |- | ||
| + | | colspan="2" | Enables or disables the software watchdog during long operations | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Enable | ||
| + | |- | ||
| + | | colspan="2" | Set true to enable, false to disable | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | + | ==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. | ||
| − | |||
| − | |||
| Line 27: | Line 31: | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::System.WDTEnable(false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::System.WDTEnable(false)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
WDTEnable |
| Enables or disables the software watchdog during long operations | |
 - BOOL
|
Enable |
| Set true to enable, false to disable | |
 - NONE
|
Return |
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)
