API Console.GetLineBytes: Difference between revisions

Revision as of 11:41, 16 January 2023

	GetLineBytes
Reads a line of bytes from the given console extending the array if needed
- 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
- ULONG	MaxBytes
The number of bytes to read, -1 for full line
- ULONG	Return

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)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Reads a line of bytes from the given console extending the array if needed
+|-
+| 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;" | '''GetLineBytes'''
-====Class hierarchy====
+|-
-[[API Console|Console]]
+| colspan="2" | Reads a line of bytes from the given console extending the array if needed&nbsp;
-:[[API Console|GetLineBytes]]
+|-
-</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 read the data from, pass -1 for final line
+|-
+| colspan="2" | The zero-based index of the line to read the data from, pass -1 for final line&nbsp;
-[[Variable Types|BYTE[]]] ''Buffer''
+|-
-:A buffer to read the data into
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[]
+| width="90%" | Buffer
-[[Variable Types|ULONG]] ''Offset''
+|-
-:An offset into Data of the first byte to write to
+| colspan="2" | A buffer to read the data into&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 number of bytes to read, -1 for full line
+|-
-:''The default value for this parameter is: '''''-1'''
+| colspan="2" | An offset into Data of the first byte to write to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-==Return value==
+| width="90%" | MaxBytes
-[[Variable Types|ULONG]]
+|-
+| colspan="2" | The number of bytes to read, -1 for full line&nbsp;
-''<span style="color:red;">No additional information</span>''
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| 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