Difference between revisions of "API Console.WriteText"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Adds a block of text to the 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;" | '''WriteText'''
 +
|-
 +
| colspan="2" | Adds a block of text to the console window&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | ConsoleHandle
 +
|-
 +
| colspan="2" | A valid console windows handle&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | Any text to add to the console&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Console|Console]]
 
−
:[[API Console|WriteText]]
 
−
</div>
 
−
__TOC__
 
  
−
==Parameters==
+
==Detailed description==
−
[[Variable types|HANDLE]] ''ConsoleHandle''
 
−
:A valid console windows handle
 
  
−
[[Variable types|STRING]] ''Text''
 
−
:Any text to add to the console
 
−
 
−
==Return value==
 
−
''This call does not return a value''
 
−
 
−
==Detailed description==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 26: Line 29:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.WriteText(consolehandle, "text")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.WriteText(consolehandle, "text")</pre>
−
 
−
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png WriteText
Adds a block of text to the console window 
Fc9-h32-icon.png - HANDLE ConsoleHandle
A valid console windows handle 
Fc9-string-icon.png - STRING Text
Any text to add to the console 
Fc9-void-icon.png - NONE Return


Detailed description

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Console.WriteText(consolehandle, "text")
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Console.WriteText&oldid=30254"