Difference between revisions of "API Console.GetLineBytes"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| 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]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLineBytes''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a line of bytes from the given console extending the array if needed | ||
| + | |- | ||
| + | |- | ||
| + | | 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 read the data from, pass -1 for final line | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE[] | ||
| + | | width="90%" | Buffer | ||
| + | |- | ||
| + | | colspan="2" | A buffer to read the data into | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | ==Detailed description== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| Line 42: | Line 45: | ||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineBytes(consolehandle, line, _arraybuffer, offset, maxbytes)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineBytes(consolehandle, line, _arraybuffer, offset, maxbytes)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 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
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)
