Document the new 24H2 APIs #323
Merged
+409
−111
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lhecker
commented
Aug 14, 2024
| ## [Console API Functions](console-functions.md) | ||
| ### [AddConsoleAlias](addconsolealias.md) | ||
| ### [AllocConsole](allocconsole.md) | ||
| ### [AllocConsoleWithOptions](allocconsolewithoptions.md) |
There was a problem hiding this comment.
🚫 Whitespace changes: https://github.com/MicrosoftDocs/Console-Docs/pull/323/files?w=1
|
Learn Build status updates of commit 20768a8: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
lhecker
commented
Aug 14, 2024
| ### [KEY_EVENT_RECORD structure](key-event-record-str.md) | ||
| ### [MENU_EVENT_RECORD structure](menu-event-record-str.md) | ||
| ### [MOUSE_EVENT_RECORD structure](mouse-event-record-str.md) | ||
| ### [SMALL_RECT structure](small-rect-str.md) |
There was a problem hiding this comment.
I sorted these alphabetically.
|
Learn Build status updates of commit ebda27d: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
3 tasks
DHowett
reviewed
Jan 6, 2025
|
|
||
| ## Examples | ||
|
|
||
| For a full walkthrough on using this function to establish a pseudoconsole session, please see [Creating a Pseudoconsole Session](creating-a-pseudoconsole-session.md). |
There was a problem hiding this comment.
This PR doesn't change this file - should it?
There was a problem hiding this comment.
Yes, but I think we should merge this first, because that article could use a bigger overhaul.
docs/releasepseudoconsole.md
Outdated
|
|
||
| ## Remarks | ||
|
|
||
| Before this method was introduced, the initial pseudoconsole API was inherently flawed: **ClosePseudoConsole** would only exit until after the pseudoconsole has finished using the output pipe. This meant that the pseudoconsole effectively kept your application alive. The **HPCON** handle owned by your application on the other hand kept the pseudoconsole session alive until **ClosePseudoConsole** was called. This created a lifetime and ownership loop. The way applications were expected to break this loop up was by manually waiting for the spawned terminal processes to exit and then call **ClosePseudoConsole**. This made the API failure prone and resulted in shutdown deadlocks in various applications. |
There was a problem hiding this comment.
I'd rephrase the "inherently flawed" part... but i am not sure how
There was a problem hiding this comment.
(We don't usually editorialize in the docs!)
DHowett
reviewed
Jul 9, 2025
docs/console-allocation-policy.md
Outdated
| | | | | ||
| |-|-| | ||
| | Minimum supported client | Windows 11 24H2 (build 26100) \[desktop apps only\] | | ||
| | Minimum supported server | n/a | |
There was a problem hiding this comment.
Suggested change
| | Minimum supported server | n/a | | |
| | Minimum supported server | Windows Server 2025 (build 26100) | |
DHowett
reviewed
Jul 9, 2025
docs/allocconsolewithoptions.md
Outdated
| | | | | ||
| |-|-| | ||
| | Minimum supported client | Windows 11 24H2 (build 26100) \[desktop apps only\] | | ||
| | Minimum supported server | n/a | |
There was a problem hiding this comment.
same note about server 2025 applies to all of these
|
Learn Build status updates of commit f8a59d2: 💡 Validation status: suggestions
docs/allocconsolewithoptions.md
docs/releasepseudoconsole.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
DHowett
approved these changes
Jul 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for:
AllocConsoleWithOptionsand its accompanying structReleasePseudoConsoleClosePseudoConsole