Difference between revisions of "API Console.GetLineBytes"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
(XML import)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
+
<sidebar>API Contents</sidebar>
 
 
<sidebar>API contents</sidebar>
 
 
Reads a line of bytes from the given console extending the array if needed
 
Reads a line of bytes from the given console extending the array if needed
  

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Reads a line of bytes from the given console extending the array if needed

Class hierarchy

Console

GetLineBytes

Parameters

HANDLE ConsoleHandle

A valid console windows handle

ULONG Line

The zero-based index of the line to read the data from, pass -1 for final line

BYTE[] Buffer

A buffer to read the data into

ULONG Offset

An offset into Data of the first byte to write to
The default value for this parameter is: 0

ULONG MaxBytes

The number of bytes to read, -1 for full line
The default value for this parameter is: -1


Return value

ULONG

No additional information


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::Console.GetLineBytes(consolehandle, line, _arraybuffer, offset, maxbytes)

No additional examples