API Console.GetLineBytes

From Flowcode Help
Revision as of 21:18, 11 May 2013 by Admin (talk | contribs) (XML import)
Jump to navigationJump to search

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

===Class hierarchy===API

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)