Difference between revisions of "API Console.GetLineText"

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Reads a line of text from the given console, pass -1 for final line
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLineText'''
====Class hierarchy====
+
|-
[[API Console|Console]]
+
| colspan="2" | Reads a line of text from the given console, pass -1 for final line&nbsp;
:[[API Console|GetLineText]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | ConsoleHandle
==Parameters==
+
|-
[[Variable Types|HANDLE]] ''ConsoleHandle''
+
| colspan="2" | A valid console windows handle&nbsp;
:A valid console windows handle
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
[[Variable Types|ULONG]] ''Line''
+
| width="90%" | Line
:The zero-based index of the line to read the text from
+
|-
 
+
| colspan="2" | The zero-based index of the line to read the text from&nbsp;
 
+
|-
==Return value==
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
[[Variable Types|STRING]]
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
+
|}
''<span style="color:red;">No additional information</span>''
 
  
  

Revision as of 11:41, 16 January 2023

Fc9-comp-macro.png GetLineText
Reads a line of text from the given console, pass -1 for final line 
Fc9-h32-icon.png - HANDLE ConsoleHandle
A valid console windows handle 
Fc9-u32-icon.png - ULONG Line
The zero-based index of the line to read the text from 
Fc9-string-icon.png - STRING Return


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon:
    result = ::Console.GetLineText(consolehandle, line)

No additional examples