API Console.GetDefault: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetDefault
Gets the default (read-only) console window
- HANDLE	Return

Detailed description

A default console is provided to allow easy debug and diagnostic to be displayed. As this is shared for all components it does not make sense to allow the user to input into this. However each component can write to this using the default console handle.

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE
Add to a calculation icon:
```
result = ::Console.GetDefault()
```

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the default (read-only) console window
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetDefault'''
+|-
+| colspan="2" | Gets the default (read-only) console window&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===
-:Console
-::GetDefault
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''This function has no parameters''
+A default console is provided to allow easy debug and diagnostic to be displayed. As this is shared for all components it does not make sense to allow the user to input into this. However each component can write to this using the default console handle.
-==Return value==
-[[Variable types|HANDLE]]
-Returns the default (read-only) console window
-==Detailed description==
-''No additional information''
 ==Examples==

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation