API Console.GetLineText: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetLineText
Reads 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 read the text from
- 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)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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''
+|}
-<sidebar>API Contents</sidebar>
+==Detailed description==
-Reads 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|GetLineText]]
-</div>
-__TOC__
-==Parameters==
-[[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]]
-''<span style="color:red;">No additional information</span>''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 33: / Line 30: @@
 * Declare a variable 'result' of type STRING
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineText(consolehandle, line)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation