API Console.SetLineBytes: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Writes a line of bytes from the given console, pass -1 for final line | Writes a line of bytes from the given console, pass -1 for final line | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Console | |||
::SetLineBytes | |||
</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== | |||
''This call does not return a value'' | ''This call does not return a value'' | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)</pre> | ||
Revision as of 17:02, 11 May 2013
<sidebar>API contents</sidebar> Writes a line of bytes from the given console, pass -1 for final line
Class hierarchy
- Console
- SetLineBytes
Parameters
HANDLE ConsoleHandle
- A valid console windows handle
ULONG Line
- The zero-based index of the line to write the data to
BYTE[] Data
- A block of data to add to the console
ULONG Offset
- An offset into Data of the first byte to read from
- The default value for this parameter is: 0
ULONG MaxBytes
- The maximum number of bytes to read, -1 for all
- The default value for this parameter is: -1
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Console.SetLineBytes(consolehandle, line, _arraydata, offset, maxbytes)