Difference between revisions of "API Console.SetLineText"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
==ConsoleSetLineText==
+
Writes a line of text from the given console, pass -1 for final line
  
Writes a line of text from the given console, pass -1 for final line
+
<div style="width:25%; float:right" class="toc">
----
+
====Class hierarchy====
 +
[[API Console|Console]]
 +
:[[API Console|SetLineText]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] ConsoleHandle''
+
[[Variable Types|HANDLE]] ''ConsoleHandle''
 
:A valid console windows handle
 
:A valid console windows handle
  
''[[Variable types|ULONG]] Line''
+
[[Variable Types|ULONG]] ''Line''
 
:The zero-based index of the line to write the text to
 
:The zero-based index of the line to write the text to
  
''[[Variable types|STRING]] Text''
+
[[Variable Types|STRING]] ''Text''
 
:A single line of text to add to the console
 
:A single line of text to add to the console
  
===Return value===
+
 
 +
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation:====
+
''<span style="color:red;">No additional information</span>''
* Add to a calculation icon: ::Console.SetLineText(consolehandle, line, "text")
+
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 +
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetLineText(consolehandle, line, "text")</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Writes a line of text from the given console, pass -1 for final line

Class hierarchy

Console

SetLineText

Parameters

HANDLE ConsoleHandle

A valid console windows handle

ULONG Line

The zero-based index of the line to write the text to

STRING Text

A single line of text to add to the console


Return value

This call does not return a value


Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Console.SetLineText(consolehandle, line, "text")

No additional examples