API Console.GetLineBytes: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|HANDLE]] ''ConsoleHandle'' | ||
:A valid console windows handle | :A valid console windows handle | ||
[[Variable | [[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 | [[Variable Types|BYTE[]]] ''Buffer'' | ||
:A buffer to read the data into | :A buffer to read the data into | ||
[[Variable | [[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 | [[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''' | ||
| Line 29: | Line 29: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|ULONG]] | ||
''<span style="color:red;">No additional information</span>'' | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> 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)
No additional information