Document what the session creation parameters do, and which of them ae visible to all users on the machine - #41020
Merged
Conversation
âĶre visible to all users on the machine
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the WSLC SDK documentation to explain what the session creation parameters represent and to clarify which session metadata can be observed machine-wide.
Changes:
- Documented the meaning of
Name/nameandStoragePath/storagePathacross C#, C++, and C API references. - Documented that session names are machine-wide identifiers and that duplicate names fail with
ERROR_ALREADY_EXISTS. - Documented which session metadata (name, creator SID, creator PID) is visible to other users on the same machine.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| doc/docs/api-reference/csharp/settings-classes/sessionsettings.md | Adds parameter semantics and notes on machine-wide visibility for C# SessionSettings. |
| doc/docs/api-reference/cpp/settings-classes/sessionsettings.md | Adds constructor parameter semantics and visibility notes for C++/WinRT SessionSettings. |
| doc/docs/api-reference/c/session-apis/wslcinitsessionsettings.md | Expands the parameter table with comments and adds visibility/name uniqueness notes for the C API. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Craig Loewen (craigloewen-msft)
approved these changes
Jul 7, 2026
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
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.
Summary of the Pull Request
This change adds explanations for what the session creation fields do, and which of them are visible to all users on the machine
PR Checklist
Detailed Description of the Pull Request / Additional comments
Validation Steps Performed