Skip to content

Windows.System.User: add Remarks to FindAllAsync overloads and GetFromId#2523

Merged
GrantMeStrength merged 10 commits intodocsfrom
jken/311108-windows-system-user-remarks
Mar 20, 2026
Merged

Windows.System.User: add Remarks to FindAllAsync overloads and GetFromId#2523
GrantMeStrength merged 10 commits intodocsfrom
jken/311108-windows-system-user-remarks

Conversation

@GrantMeStrength
Copy link
Copy Markdown
Contributor

@GrantMeStrength GrantMeStrength commented Mar 20, 2026

Addresses ADO work item #311108 (GitHub issues #1144, #1742, #1195).

Changes

FindAllAsync (all three overloads)

  • Added ## -remarks explaining 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.
  • Added cross-reference to GetDefault (Windows 10, version 2104) as the preferred API for identifying the current process user.
  • The deprecated FindAllAsync(UserType, UserAuthenticationStatus) overload now includes a [!WARNING] callout directing users to FindAllAsync or GetDefault.

GetFromId

  • Added ## -remarks documenting that passing an unrecognized nonRoamableId returns 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.

@prmerger-automator prmerger-automator Bot added do-not-merge PR is being processed and awaiting review/approval. docs-editor-pilot review-team-triage labels Mar 20, 2026
@GrantMeStrength GrantMeStrength requested a review from Copilot March 20, 2026 16:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 FindAllAsync overloads describing desktop vs Xbox results and clarifying that it doesn’t enumerate all device accounts.
  • Added guidance to prefer User.GetDefault for identifying the current process user (and added a deprecation warning callout on the deprecated overload).
  • Added GetFromId remarks documenting null return for unknown IDs and the device-specific nature of nonRoamableId.

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.

Comment thread windows.system/user_findallasync_711678667.md
Comment thread windows.system/user_findallasync_326280522.md
Comment thread windows.system/user_findallasync_1333355945.md
GrantMeStrength and others added 6 commits March 20, 2026 09:51
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>
@GrantMeStrength GrantMeStrength merged commit a77436d into docs Mar 20, 2026
1 check passed
@GrantMeStrength GrantMeStrength deleted the jken/311108-windows-system-user-remarks branch March 20, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge PR is being processed and awaiting review/approval. docs-editor-pilot review-team-triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants