Difference between revisions of "API Console.GetLineText"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
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"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy=== | + | ====Class hierarchy==== |
| − | + | [[API Console|Console]] | |
| − | : | + | :[[API Console|GetLineText]] |
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''ConsoleHandle'' | |
:A valid console windows handle | :A valid console windows handle | ||
| − | + | [[Variable Types|ULONG]] ''Line'' | |
: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== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|STRING]] |
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
| − | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 28: | Line 31: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineText(consolehandle, line)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineText(consolehandle, line)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Reads a line of text from the given console, pass -1 for final line
Contents
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)
No additional examples
