Difference between revisions of "API Console.GetLineBytes"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
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 | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Console | ||
| + | ::GetLineBytes | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] ConsoleHandle'' | ''[[Variable types|HANDLE]] ConsoleHandle'' | ||
:A valid console windows handle | :A valid console windows handle | ||
| Line 21: | Line 27: | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| − | + | ==Return value== | |
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
No additional information | No additional information | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.GetLineBytes(consolehandle, line, _arraybuffer, offset, maxbytes)</pre> |
Revision as of 17:02, 11 May 2013
<sidebar>API contents</sidebar> Reads a line of bytes from the given console extending the array if needed
Class hierarchy
- Console
- GetLineBytes
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)
