API Console.SetLineBytes: Difference between revisions

Revision as of 11:41, 16 January 2023

	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

No additional information

Examples

Calling in a calculation

Add to a calculation icon:

::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Writes a line of bytes from the given console, pass -1 for final line
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLineBytes'''
-====Class hierarchy====
+|-
-[[API Console|Console]]
+| colspan="2" | Writes a line of bytes from the given console, pass -1 for final line&nbsp;
-:[[API Console|SetLineBytes]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | ConsoleHandle
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''ConsoleHandle''
+| colspan="2" | A valid console windows handle&nbsp;
-:A valid console windows handle
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable Types|ULONG]] ''Line''
+| width="90%" | Line
-:The zero-based index of the line to write the data to
+|-
+| colspan="2" | The zero-based index of the line to write the data to&nbsp;
-[[Variable Types|BYTE[]]] ''Data''
+|-
-:A block of data to add to the console
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[]
+| width="90%" | Data
-[[Variable Types|ULONG]] ''Offset''
+|-
-:An offset into Data of the first byte to read from
+| colspan="2" | A block of data to add to the console&nbsp;
-:''The default value for this parameter is: '''''0'''
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable Types|ULONG]] ''MaxBytes''
+| width="90%" | Offset
-:The maximum number of bytes to read, -1 for all
+|-
-:''The default value for this parameter is: '''''-1'''
+| colspan="2" | An offset into Data of the first byte to read from&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-==Return value==
+| width="90%" | MaxBytes
-''This call does not return a value''
+|-
+| colspan="2" | The maximum number of bytes to read, -1 for all&nbsp;
+|-
+| 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''
+|}

Wiki bot (talk | contribs)

Revision as of 11:41, 16 January 2023

Detailed description

Examples

Calling in a calculation