Jump to content

API Console.SetLineText: Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,427 edits
Admin (talk | contribs)
3,524 edits
XML import of API auto-gen
 
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
wiki page name
{| class="mtx-class-macrotable wikitable"
==ConsoleSetLineText==
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetLineText'''
|-
| colspan="2" | Writes a line of text from the given console, pass -1 for final line 
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | ConsoleHandle
|-
| colspan="2" | A valid console windows handle 
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Line
|-
| colspan="2" | The zero-based index of the line to write the text to 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | A single line of text to add to the console 
|-
| 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''
|}


Writes a line of text from the given console, pass -1 for final line
----


===Parameters===
==Detailed description==
''[[Variable types|HANDLE]] ConsoleHandle''
:A valid console windows handle


''[[Variable types|ULONG]] Line''
:The zero-based index of the line to write the text to


''[[Variable types|STRING]] Text''
:A single line of text to add to the console


===Return value===
==Examples==
''This call does not return a value''
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetLineText(consolehandle, line, "text")</pre>
===Detailed description===
''No additional information''
 
===Examples===
====Calling in a calculation:====
* Add to a calculation icon: ::Console.SetLineText(consolehandle, line, "text")

Latest revision as of 14:11, 13 July 2026

SetLineText
Writes a line of text from the given console, pass -1 for final line 
- 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 
- NONE Return


Detailed description

Examples

Calling in a calculation

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