Difference between revisions of "API Console.GetDefault"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Gets the default (read-only) console window
 
Gets the default (read-only) console window
Line 28: Line 30:
 
* 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 information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Gets the default (read-only) console window

Class hierarchy

Console

GetDefault

Parameters

This function has no parameters


Return value

HANDLE

Returns the default (read-only) console window


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