API Console.GetLineText: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Reads a line of text from the given console, pass -1 for final line | Reads a line of text from the given console, pass -1 for final line | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Console | |||
::GetLineText | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] ConsoleHandle'' | ''[[Variable types|HANDLE]] ConsoleHandle'' | ||
:A valid console windows handle | :A valid console windows handle | ||
| Line 10: | Line 16: | ||
:The zero-based index of the line to read the text from | :The zero-based index of the line to read the text from | ||
==Return value== | |||
[[Variable types|STRING]] | [[Variable types|STRING]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''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:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineText(consolehandle, line)</pre> | ||
Revision as of 16:58, 11 May 2013
<sidebar>API contents</sidebar> Reads a line of text from the given console, pass -1 for final line
Class hierarchy
- Console
- GetLineText
Parameters
HANDLE ConsoleHandle
- A valid console windows handle
ULONG Line
- The zero-based index of the line to read the text from
Return value
No additional information
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)