Difference between revisions of "API Console.GetDefault"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
wiki page name
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets the default (read-only) console window
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDefault'''
 +
|-
 +
| colspan="2" | Gets the default (read-only) console window 
 +
|-
 +
|-
 +
| 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''
 +
|}
  
  
===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
+
==Examples==
 
+
===Calling in a calculation===
===Detailed description===
 
''No additional information''
 
 
 
===Examples===
 
====Calling in a calculation====
 
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: result = ::Console.GetDefault()
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetDefault()</pre>

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