ResizePseudoConsole function

Article
09/20/2022

Resizes the internal buffers for a pseudoconsole to the given size.

Syntax

HRESULT WINAPI ResizePseudoConsole(
    _In_ HPCON hPC ,
    _In_ COORD size
);

Parameters

hPC [in]
A handle to an active pseudoconsole as opened by CreatePseudoConsole.

size [in]
The dimensions of the window/buffer in count of characters that will be used for the internal buffer of this pseudoconsole.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This function can resize the internal buffers in the pseudoconsole session to match the window/buffer size being used for display on the terminal end. This ensures that attached Command-Line Interface (CUI) applications using the Console Functions to communicate will have the correct dimensions returned in their calls.

Requirements


Minimum supported client	Windows 10 October 2018 Update (version 1809) [desktop apps only]
Minimum supported server	Windows Server 2019 [desktop apps only]
Header	ConsoleApi.h (via WinCon.h, include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll