Jump to content

API Console.GetDefault: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import
No edit summary
Line 1: Line 1:
<sidebar>API Contents</sidebar>
{| 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]]
<div style="width:25%; float:right" class="toc">
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDefault'''
====Class hierarchy====
|-
[[API Console|Console]]
| colspan="2" | Gets the default (read-only) console window&nbsp;
:[[API Console|GetDefault]]
|-
</div>
|-
__TOC__
| 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==
|}
''This function has no parameters''
 
 
==Return value==
[[Variable Types|HANDLE]]
 
Returns the default (read-only) console window





Revision as of 11:41, 16 January 2023

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

No additional examples