Kernel32ReadConsoleOutput Method

[DllImportAttribute("Kernel32.dll", SetLastError = true)]
public static bool ReadConsoleOutput(
	IntPtr consoleOutput,
	IntPtr buffer,
	ConsoleCoordinate bufferSize,
	ConsoleCoordinate bufferCoord,
	ref NativeRectangleSmall refReadRegion
)

<DllImportAttribute("Kernel32.dll", SetLastError := true>]
Public Shared Function ReadConsoleOutput ( 
	consoleOutput As IntPtr,
	buffer As IntPtr,
	bufferSize As ConsoleCoordinate,
	bufferCoord As ConsoleCoordinate,
	ByRef refReadRegion As NativeRectangleSmall
) As Boolean

Dim consoleOutput As IntPtr
Dim buffer As IntPtr
Dim bufferSize As ConsoleCoordinate
Dim bufferCoord As ConsoleCoordinate
Dim refReadRegion As NativeRectangleSmall

Dim returnValue As Boolean

returnValue = Kernel32.ReadConsoleOutput(consoleOutput, 
	buffer, bufferSize, bufferCoord, 
	refReadRegion)

public:
[DllImportAttribute(L"Kernel32.dll", SetLastError = true)]
static bool ReadConsoleOutput(
	IntPtr consoleOutput, 
	IntPtr buffer, 
	ConsoleCoordinate bufferSize, 
	ConsoleCoordinate bufferCoord, 
	NativeRectangleSmall% refReadRegion
)

[<DllImportAttribute("Kernel32.dll", SetLastError = true)>]
static member ReadConsoleOutput : 
        consoleOutput : IntPtr * 
        buffer : IntPtr * 
        bufferSize : ConsoleCoordinate * 
        bufferCoord : ConsoleCoordinate * 
        refReadRegion : NativeRectangleSmall byref -> bool 

No code example is currently available or this language may not be supported.

Parameters

consoleOutput  IntPtr

A handle to the console screen buffer.

The handle must have the StandardRightsRead (GENERIC_READ) access right.

buffer  IntPtr

A pointer to a destination buffer that receives the data read from the console screen buffer.

This pointer is treated as the origin of a two-dimensional array of CharInfo structures whose size is specified by the bufferSize parameter.

bufferSize  ConsoleCoordinate

The size of the buffer parameter, in character cells.

The X member structure is the number of columns; the Y member is the number of rows.

bufferCoord  ConsoleCoordinate

The coordinates of the upper-left cell in the lpBuffer parameter that receives the data read from the console screen buffer.

The X member structure is the column; the Y member is the row.

refReadRegion  NativeRectangleSmall

A pointer to a NativeRectangleSmall structure.

On input, the structure members specify the upper-left and lower-right coordinates of the console screen buffer rectangle from which the function is to read.

On output, the structure members specify the actual rectangle that was used.

Return Value

If the function fails, the return value is .

To get extended error information, call GetLastWin32Error.

Reference