Difference between revisions of "API Console.AddText"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Adds a window to the list of consoles available
 
Adds a window to the list of consoles available
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Console
 +
::AddText
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|STRING]] Name''
 
''[[Variable types|STRING]] Name''
 
:The name to appear as the consoles title
 
:The name to appear as the consoles title
Line 10: Line 16:
 
:Set true to allow input from the User
 
:Set true to allow input from the User
  
===Return value===
+
==Return value==
 
[[Variable types|HANDLE]]
 
[[Variable types|HANDLE]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[C]">result = ::Console.AddText("name", true)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.AddText("name", true)</pre>

Revision as of 16:57, 11 May 2013

<sidebar>API contents</sidebar> Adds a window to the list of consoles available

Class hierarchy

Console
AddText

Parameters

STRING Name

The name to appear as the consoles title

BOOL UserWrite

Set true to allow input from the User

Return value

HANDLE

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Console.AddText("name", true)