API Console.GetLineBytes: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API Console|Console]] | ====Class hierarchy==== | ||
[[API Console|Console]] | |||
:[[API Console|GetLineBytes]] | :[[API Console|GetLineBytes]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==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''' | ||
| Line 29: | Line 30: | ||
[[Variable types|ULONG]] | [[Variable types|ULONG]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 38: | Line 42: | ||
* 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> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:10, 11 May 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