Windows.System.User: add Remarks to FindAllAsync overloads and GetFromId#2523
Merged
GrantMeStrength merged 10 commits intodocsfrom Mar 20, 2026
Merged
Windows.System.User: add Remarks to FindAllAsync overloads and GetFromId#2523GrantMeStrength merged 10 commits intodocsfrom
GrantMeStrength merged 10 commits intodocsfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Windows.System.User API reference docs to clarify platform-specific behavior of FindAllAsync overloads and GetFromId, aligning guidance with expected usage for identifying the current user and handling missing users.
Changes:
- Added remarks to all
FindAllAsyncoverloads describing desktop vs Xbox results and clarifying that it doesn’t enumerate all device accounts. - Added guidance to prefer
User.GetDefaultfor identifying the current process user (and added a deprecation warning callout on the deprecated overload). - Added
GetFromIdremarks documentingnullreturn for unknown IDs and the device-specific nature ofnonRoamableId.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| windows.system/user_getfromid_2093276151.md | Adds remarks about null return and device-specific nonRoamableId. |
| windows.system/user_findallasync_711678667.md | Adds platform behavior remarks + points to GetDefault; adjusts see-also formatting. |
| windows.system/user_findallasync_326280522.md | Adds platform behavior remarks + points to GetDefault; adjusts see-also formatting. |
| windows.system/user_findallasync_1333355945.md | Adds deprecation warning + platform behavior remarks; adjusts see-also formatting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…platform-specific claims
…rified platform-specific claims
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.
Addresses ADO work item #311108 (GitHub issues #1144, #1742, #1195).
Changes
FindAllAsync (all three overloads)
## -remarksexplaining that on desktop, the method returns at most one user (the interactive user in the caller's session); on Xbox, it may return multiple users. The method does not enumerate all accounts on the device.GetDefault(Windows 10, version 2104) as the preferred API for identifying the current process user.FindAllAsync(UserType, UserAuthenticationStatus)overload now includes a[!WARNING]callout directing users toFindAllAsyncorGetDefault.GetFromId
## -remarksdocumenting that passing an unrecognizednonRoamableIdreturns null, and noting the device-specific nature of the identifier.Not in this PR
Issue #1830 (
GetPropertiesAsync— AAD AccountName/DomainName table accuracy) is tracked separately. The customer reports the AAD column may be wrong (AccountName available, DomainName not). The issue was 6 years old and lacked information and so was closed.