Difference between revisions of "API Console.GetDefault"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets the default (read-only) console window | Gets the default (read-only) console window | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Console|Console]] | + | ====Class hierarchy==== |
| + | [[API Console|Console]] | ||
:[[API Console|GetDefault]] | :[[API Console|GetDefault]] | ||
</div> | </div> | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
''This function has no parameters'' | ''This function has no parameters'' | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] |
Returns the default (read-only) console window | Returns the default (read-only) console window | ||
| + | |||
==Detailed description== | ==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== | ==Examples== | ||
| Line 23: | Line 27: | ||
* 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 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the default (read-only) console window
Contents
Parameters
This function has no parameters
Return value
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
