C# Signature:

[DllImport("kernel32.dll")]
static extern bool ReadConsoleOutputCharacter(IntPtr hConsoleOutput,
   [Out] StringBuilder lpCharacter, uint nLength, COORD dwReadCoord,
   out uint lpNumberOfCharsRead);

User-Defined Types:

None.

Notes:

None.

Tips & Tricks:

Please add some!

Sample Code:

[DllImport("Kernel32", SetLastError=true)]
private static extern IntPtr GetStdHandle(uint nStdHandle);

[DllImport("Kernel32", SetLastError=true)]
static extern bool ReadConsoleOutputCharacter(IntPtr hConsoleOutput,
    [Out] StringBuilder lpCharacter, uint nLength, COORD dwReadCoord,
    out uint lpNumberOfCharsRead);

[StructLayout(LayoutKind.Sequential)]
private struct COORD
{
    public short X;
    public short Y;
}

private string ReadALineOfConsoleOutput()
{
    IntPtr stdout = GetStdHandle(STD_OUTPUT_HANDLE);

    if ( stdout.ToInt32() == INVALID_HANDLE_VALUE )
    throw new Win32Exception();

    // this assumes the console screen buffer is 80 columns wide.
    // You can call GetConsoleScreenBufferInfo() to get its actual dimensions.
    uint nLength = 80;    
// Before reading from the console, allocate the console using AllocConsole(), or attach to an existing console using AttachConsole().
// Then call GetStdHandle() to get an IntPtr for the stdout handle. Then call ReadConsoleOutputCharacter() as shown in this example.
private string ReadFromConsole(IntPtr stdout)
{
    uint nLength = 80;
    StringBuilder lpCharacter = new StringBuilder((int)nLength);

    // read from the first character of the first line (0, 0).
    // read from the first character of the first line (0, 0)
    COORD dwReadCoord;
    dwReadCoord.X = 0;
    dwReadCoord.Y = 0;

    uint lpNumberOfCharsRead = 0;

    if ( !ReadConsoleOutputCharacter(stdout, lpCharacter, nLength, dwReadCoord, out lpNumberOfCharsRead) )
    throw new Win32Exception();

    return lpCharacter.ToString();
}

Alternative Managed API:

Do you know one? Please contribute it!

Please edit this page!

Do you have...

• helpful tips or sample code to share for using this API in managed code?
• corrections to the existing content?
• variations of the signature you want to share?
• additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).