API System.WDTEnable: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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)
```

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''WDTEnable'''
+|-
+| colspan="2" | Enables or disables the software watchdog during long operations&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Enable
+|-
+| colspan="2" | Set true to enable, false to disable&nbsp;
+|-
+| 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''
+|}
-<sidebar>API Contents</sidebar>
+==Detailed description==
-Enables or disables the software watchdog during long operations
+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.
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API System|System]]
-:[[API System|WDTEnable]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|BOOL]] ''Enable''
-:Set true to enable, false to disable
+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.
-==Return value==
-''This call does not return a value''
+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.
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 27: / Line 31: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::System.WDTEnable(false)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation