API Console.GetLineBytes: Difference between revisions
XML import of API auto-gen |
XML import API auto-gen |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
Reads a line of bytes from the given console extending the array if needed | |||
===Parameters=== | ===Parameters=== | ||
| Line 32: | Line 30: | ||
===Examples=== | ===Examples=== | ||
====Calling in a calculation | ====Calling in a calculation==== | ||
* Declare a variable 'result' of type ULONG | * 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: result = ::Console.GetLineBytes(consolehandle, line, _arraybuffer, offset, maxbytes) | ||
Revision as of 15:34, 10 May 2013
wiki page name Reads a line of bytes from the given console extending the array if needed
Parameters
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
- The default value for this parameter is: 0
ULONG MaxBytes
- The number of bytes to read, -1 for full line
- The default value for this parameter is: -1
Return value
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)