Kernel32ReadConsoleOutputCharacter Method
Copies a number of characters from consecutive cells of a console screen buffer, beginning at a specified location.
Namespace: DevCase.Win32.NativeMethodsAssembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.
[DllImportAttribute("Kernel32.dll", CharSet = CharSet.Auto, BestFitMapping = false,
ThrowOnUnmappableChar = true, SetLastError = true)]
public static bool ReadConsoleOutputCharacter(
IntPtr consoleOutput,
StringBuilder character,
uint length,
ConsoleCoordinate readCoord,
out uint refNumberOfCharsRead
)
<DllImportAttribute("Kernel32.dll", CharSet := CharSet.Auto, BestFitMapping := false,
ThrowOnUnmappableChar := true, SetLastError := true>]
Public Shared Function ReadConsoleOutputCharacter (
consoleOutput As IntPtr,
character As StringBuilder,
length As UInteger,
readCoord As ConsoleCoordinate,
<OutAttribute> ByRef refNumberOfCharsRead As UInteger
) As Boolean
Dim consoleOutput As IntPtr
Dim character As StringBuilder
Dim length As UInteger
Dim readCoord As ConsoleCoordinate
Dim refNumberOfCharsRead As UInteger
Dim returnValue As Boolean
returnValue = Kernel32.ReadConsoleOutputCharacter(consoleOutput,
character, length, readCoord, refNumberOfCharsRead)
public:
[DllImportAttribute(L"Kernel32.dll", CharSet = CharSet::Auto, BestFitMapping = false,
ThrowOnUnmappableChar = true, SetLastError = true)]
static bool ReadConsoleOutputCharacter(
IntPtr consoleOutput,
StringBuilder^ character,
unsigned int length,
ConsoleCoordinate readCoord,
[OutAttribute] unsigned int% refNumberOfCharsRead
)
[<DllImportAttribute("Kernel32.dll", CharSet = CharSet.Auto, BestFitMapping = false,
ThrowOnUnmappableChar = true, SetLastError = true)>]
static member ReadConsoleOutputCharacter :
consoleOutput : IntPtr *
character : StringBuilder *
length : uint32 *
readCoord : ConsoleCoordinate *
refNumberOfCharsRead : uint32 byref -> bool
No code example is currently available or this language may not be supported.
- consoleOutput IntPtr
-
A handle to the console screen buffer.
The handle must have the StandardRightsRead access right.
- character StringBuilder
-
A pointer to a buffer that receives the characters read from the console screen buffer.
- length UInt32
-
The number of screen buffer character cells from which to read.
The size of the buffer pointed to by the lpCharacter parameter should be length * sizeof(TCHAR).
- readCoord ConsoleCoordinate
-
The coordinates of the first cell in the console screen buffer from which to read, in characters.
The X member is the column,
and the Y member is the row.
- refNumberOfCharsRead UInt32
-
A pointer to a variable that receives the number of characters actually read.
Boolean
If the function succeeds, the return value is
.
If the function fails, the return value is
.
To get extended error information, call
GetLastWin32Error.