Difference between revisions of "API Console.GetLineBytes"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
(XML import of updated API docs) |
||
Line 1: | Line 1: | ||
+ | |||
+ | |||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Reads a line of bytes from the given console extending the array if needed | Reads a line of bytes from the given console extending the array if needed | ||
Line 43: | Line 45: | ||
* 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> | ||
− | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Revision as of 09:58, 17 June 2013
<sidebar>API contents</sidebar>
Reads a line of bytes from the given console extending the array if needed
Contents
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)
No additional examples