Difference between revisions of "API Console.SetLineBytes"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
  
−
<sidebar>API Contents</sidebar>
+
==Detailed description==
−
Writes a line of bytes from the given console, pass -1 for final line
 
−
 
 
−
<div style="width:25%; float:right" class="toc">
 
−
====Class hierarchy====
 
−
[[API Console|Console]]
 
−
:[[API Console|SetLineBytes]]
 
−
</div>
 
−
__TOC__
 
−
 
 
−
==Parameters==
 
−
[[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''
 
−
:An offset into Data of the first byte to read from
 
−
:''The default value for this parameter is: '''''0'''
 
−
 
 
−
[[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==
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
Line 41: Line 44:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)</pre>
−
 
−
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png SetLineBytes
Writes a line of bytes from the given console, pass -1 for final line 
Fc9-h32-icon.png - HANDLE ConsoleHandle
A valid console windows handle 
Fc9-u32-icon.png - ULONG Line
The zero-based index of the line to write the data to 
Fc9-u8-icon.png - BYTE[] Data
A block of data to add to the console 
Fc9-u32-icon.png - ULONG Offset
An offset into Data of the first byte to read from 
Fc9-u32-icon.png - ULONG MaxBytes
The maximum number of bytes to read, -1 for all 
Fc9-void-icon.png - 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=30258"