Jump to content

API Console.SetLineBytes: Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,426 edits
Admin (talk | contribs)
3,524 edits
XML import API auto-gen
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
API contents
{| class="mtx-class-macrotable wikitable"
Writes a line of bytes from the given console, pass -1 for final line
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetLineBytes'''
|-
| colspan="2" | Writes a line of bytes from the given console, pass -1 for final line 
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | ConsoleHandle
|-
| colspan="2" | A valid console windows handle 
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Line
|-
| colspan="2" | The zero-based index of the line to write the data to 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[]
| width="90%" | Data
|-
| colspan="2" | A block of data to add to the console 
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Offset
|-
| colspan="2" | An offset into Data of the first byte to read from 
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | MaxBytes
|-
| colspan="2" | The maximum number of bytes to read, -1 for all 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===Parameters===
==Detailed description==
''[[Variable types|HANDLE]] ConsoleHandle''
:A valid console windows handle


''[[Variable types|ULONG]] Line''
:The zero-based index of the line to write the data to


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


''[[Variable types|ULONG]] Offset''
==Examples==
:An offset into Data of the first byte to read from
===Calling in a calculation===
:''The default value for this parameter is: '''''0'''
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)</pre>
 
''[[Variable types|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)

Latest revision as of 14:11, 13 July 2026

SetLineBytes
Writes a line of bytes from the given console, pass -1 for final line 
- 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 
- ULONG MaxBytes
The maximum number of bytes to read, -1 for all 
- NONE Return


Detailed description

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Console.SetLineBytes&oldid=43244"