Difference between revisions of "API Console.GetLineText"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(12 intermediate revisions by 3 users not shown)
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]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLineText'''
 +
|-
 +
| colspan="2" | Reads a line of text from the given console, pass -1 for final line&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-u32-icon.png]] - ULONG
 +
| width="90%" | Line
 +
|-
 +
| colspan="2" | The zero-based index of the line to read the text from&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] ConsoleHandle''
 
−
:A valid console windows handle
 
  
−
''[[Variable types|ULONG]] Line''
 
−
:The zero-based index of the line to read the text from
 
  
−
===Return value===
 
−
[[Variable types|STRING]]
 
  
−
No additional information
+
==Examples==
−
 
+
===Calling in a calculation===
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
−
* Add to a calculation icon: <pre class="brush:[C]">result = ::Console.GetLineText(consolehandle, line)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineText(consolehandle, line)</pre>

Latest revision as of 11:55, 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

Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon: 
    result = ::Console.GetLineText(consolehandle, line)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Console.GetLineText&oldid=30255"