API Console.GetLineBytes: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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

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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Reads a line of bytes from the given console extending the array if needed
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetLineBytes'''
+|-
+| colspan="2" | Reads a line of bytes from the given console extending the array if needed&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | ConsoleHandle
+|-
+| colspan="2" | A valid console windows handle&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Line
+|-
+| colspan="2" | The zero-based index of the line to read the data from, pass -1 for final line&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[]
+| width="90%" | Buffer
+|-
+| colspan="2" | A buffer to read the data into&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Offset
+|-
+| colspan="2" | An offset into Data of the first byte to write to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | MaxBytes
+|-
+| colspan="2" | The number of bytes to read, -1 for full line&nbsp;
+|-
+| 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''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] ConsoleHandle''
-:A valid console windows handle
-''[[Variable types|ULONG]] Line''
-:The zero-based index of the line to read the data from, pass -1 for final line
-''[[Variable types|BYTE[]]] Buffer''
-:A buffer to read the data into
-''[[Variable types|ULONG]] Offset''
+==Examples==
-:An offset into Data of the first byte to write to
+===Calling in a calculation===
-:''The default value for this parameter is: '''''0'''
-''[[Variable types|ULONG]] MaxBytes''
-:The number of bytes to read, -1 for full line
-:''The default value for this parameter is: '''''-1'''
-===Return value===
-[[Variable types|ULONG]]
-No additional information
-===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)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineBytes(consolehandle, line, _arraybuffer, offset, maxbytes)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation