API Console.GetLineBytes: Difference between revisions

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

Console

GetLineBytes

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

No additional information

No additional information

Add to a calculation icon:

result = ::Console.GetLineBytes(consolehandle, line, _arraybuffer, offset, maxbytes)

@@ Line 2: / Line 2: @@
 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===
+==Parameters==
 ''[[Variable types|HANDLE]] ConsoleHandle''
 :A valid console windows handle
@@ Line 21: / Line 27: @@
 :''The default value for this parameter is: '''''-1'''
-===Return value===
+==Return value==
 [[Variable types|ULONG]]
 No additional information
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
 * Declare a variable 'result' of type ULONG
-* Add to a calculation icon: <pre class="brush:[C]">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>