Skip to content

Update CreatePseudoConsole documentation to mention the Console Host #348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
logiclrd wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −0
Open

Update CreatePseudoConsole documentation to mention the Console Host #348

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
888d69d
Added a paragraph to the Remarks section of createpseudoconsole.md el…
logiclrd Mar 24, 2026
16d77ac
Fixed the absolute link href.
logiclrd Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/createpseudoconsole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ On the output stream, the [virtual terminal sequences](console-virtual-terminal-

On the input stream, plain text represents standard keyboard keys input by a user. More complicated operations are represented by encoding control keys and mouse movements as [virtual terminal sequences](console-virtual-terminal-sequences.md) embedded in this stream.

The `CreatePseudoConsole` function creates a process called the [Console Host](definitions.md#console-host) that is in charge of translating console activity to and from the input and output streams. This runs as a separate system process from any applications run within the same console. As such, security and isolation flags set during process creation can affect the ability of the Console Host to properly control console applications. For example, if a child process associated with a pseudo console is started with the [`CREATE_NEW_PROCESS_GROUP`](/windows/win32/procthread/process-creation-flags#CREATE_NEW_PROCESS_GROUP) flag, then the Console Host and the application will be running in different signalling groups, which prevents Ctrl-C and Ctrl-Break signals from propagating properly.

The handle created by this function must be closed with [ClosePseudoConsole](closepseudoconsole.md) when operations are complete.

If using `PSEUDOCONSOLE_INHERIT_CURSOR`, the calling application should be prepared to respond to the request for the cursor state in an asynchronous fashion on a background thread by forwarding or interpreting the request for cursor information that will be received on `hOutput` and replying on `hInput`. Failure to do so may cause the calling application to hang while making another request of the pseudoconsole system.
Expand Down