Difference between revisions of "API Console.GetLineBytes"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <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 | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Console|Console]] | ||
| + | :[[API Console|GetLineBytes]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''ConsoleHandle'' | |
:A valid console windows handle | :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 | :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 | :A buffer to read the data into | ||
| − | + | [[Variable Types|ULONG]] ''Offset'' | |
:An offset into Data of the first byte to write to | :An offset into Data of the first byte to write to | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| − | + | [[Variable Types|ULONG]] ''MaxBytes'' | |
:The number of bytes to read, -1 for full line | :The number of bytes to read, -1 for full line | ||
:''The default value for this parameter is: '''''-1''' | :''The default value for this parameter is: '''''-1''' | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|ULONG]] | ||
| − | + | ''<span style="color:red;">No additional information</span>'' | |
| − | ''No additional information'' | ||
| − | ===Examples | + | |
| − | + | ==Detailed description== | |
| + | ''<span style="color:red;">No additional information</span>'' | ||
| + | |||
| + | |||
| + | ==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> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<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
