Difference between revisions of "API Console.GetDefault"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<sidebar>API Contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
Gets the default (read-only) console window
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDefault'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Gets the default (read-only) console window&nbsp;
====Class hierarchy====
+
|-
[[API Console|Console]]
+
|-
:[[API Console|GetDefault]]
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
</div>
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
__TOC__
+
|}
 
 
==Parameters==
 
''This function has no parameters''
 
 
 
 
 
==Return value==
 
[[Variable Types|HANDLE]]
 
 
 
Returns the default (read-only) console window
 
  
  
Line 29: Line 20:
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetDefault()</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetDefault()</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetDefault
Gets the default (read-only) console window 
Fc9-h32-icon.png - 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()