Difference between revisions of "API Console.GetLineText"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<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">
 +
====Class hierarchy====
 +
[[API Console|Console]]
 +
:[[API Console|GetLineText]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] ConsoleHandle''
+
[[Variable Types|HANDLE]] ''ConsoleHandle''
 
:A valid console windows handle
 
:A valid console windows handle
  
''[[Variable types|ULONG]] Line''
+
[[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===
 
[[Variable types|STRING]]
 
  
No additional information
+
==Return value==
 +
[[Variable Types|STRING]]
  
===Detailed description===
+
''<span style="color:red;">No additional information</span>''
''No additional information''
 
  
===Examples===
+
 
====Calling in a calculation====
+
==Detailed description==
 +
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
* Add to a calculation icon: result = ::Console.GetLineText(consolehandle, line)
+
* 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

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

STRING

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