Jump to content

API Console.SetLineBytes: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
Line 10: Line 10:


==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 write the data to
:The zero-based index of the line to write the data to


[[Variable types|BYTE[]]] ''Data''
[[Variable Types|BYTE[]]] ''Data''
:A block of data to add to the console
:A block of data to add to the console


[[Variable types|ULONG]] ''Offset''
[[Variable Types|ULONG]] ''Offset''
:An offset into Data of the first byte to read from
:An offset into Data of the first byte to read from
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''


[[Variable types|ULONG]] ''MaxBytes''
[[Variable Types|ULONG]] ''MaxBytes''
:The maximum number of bytes to read, -1 for all
:The maximum number of bytes to read, -1 for all
:''The default value for this parameter is: '''''-1'''
:''The default value for this parameter is: '''''-1'''

Revision as of 11:08, 10 June 2013

<sidebar>API contents</sidebar> Writes a line of bytes from the given console, pass -1 for final line

Class hierarchy

Console

SetLineBytes

Parameters

HANDLE ConsoleHandle

A valid console windows handle

ULONG Line

The zero-based index of the line to write the data to

BYTE[] Data

A block of data to add to the console

ULONG Offset

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

ULONG MaxBytes

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


Return value

This call does not return a value


Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)

No additional information