Skip to content

Commit a77436d

Browse files
Merge pull request #2523 from MicrosoftDocs/jken/311108-windows-system-user-remarks
Windows.System.User: add Remarks to FindAllAsync overloads and GetFromId
2 parents 0c7207c + 6c09cc1 commit a77436d

4 files changed

Lines changed: 18 additions & 3 deletions

File tree

windows.system/user_findallasync_1333355945.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,14 @@ The authentication status of users to find.
2323
When this method completes successfully, it returns a list (type [IVectorView](../windows.foundation.collections/ivectorview_1.md)) of [Users](user.md).
2424

2525
## -remarks
26+
> [!WARNING]
27+
> This overload is deprecated. Use [FindAllAsync](user_findallasync_326280522.md) or [GetDefault](user_getdefault_846721868.md) instead.
28+
29+
This method returns users who are currently signed in to the same session as the calling application. It does not enumerate all accounts stored on the device.
30+
31+
To get the user running the current process directly, use [GetDefault](user_getdefault_846721868.md) (available from Windows 10, version 2104).
2632

2733
## -examples
2834

2935
## -see-also
30-
[FindAllAsync](user_findallasync_326280522.md), [FindAllAsync(UserType)](user_findallasync_711678667.md)
36+
[FindAllAsync](user_findallasync_326280522.md), [FindAllAsync(UserType)](user_findallasync_711678667.md)

windows.system/user_findallasync_326280522.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@ Finds all users asynchronously.
1616
When this method completes successfully, it returns a list (type [IVectorView](../windows.foundation.collections/ivectorview_1.md)) of [Users](user.md).
1717

1818
## -remarks
19+
This method returns users who are currently signed in to the same session as the calling application. It does not enumerate all accounts stored on the device.
20+
21+
To get the user running the current process directly, use [GetDefault](user_getdefault_846721868.md) (available from Windows 10, version 2104).
1922

2023
## -examples
2124

2225
## -see-also
23-
[FindAllAsync(UserType)](user_findallasync_711678667.md), [FindAllAsync(UserType, UserAuthenticationStatus)](user_findallasync_1333355945.md)
26+
[FindAllAsync(UserType)](user_findallasync_711678667.md), [FindAllAsync(UserType, UserAuthenticationStatus)](user_findallasync_1333355945.md)

windows.system/user_findallasync_711678667.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,11 @@ The type of users to find.
2020
When this method completes successfully, it returns a list (type [IVectorView](../windows.foundation.collections/ivectorview_1.md)) of [Users](user.md).
2121

2222
## -remarks
23+
This method returns users who are currently signed in to the same session as the calling application. It does not enumerate all accounts stored on the device.
24+
25+
To get the user running the current process directly, use [GetDefault](user_getdefault_846721868.md) (available from Windows 10, version 2104).
2326

2427
## -examples
2528

2629
## -see-also
27-
[FindAllAsync](user_findallasync_326280522.md), [FindAllAsync(UserType, UserAuthenticationStatus)](user_findallasync_1333355945.md)
30+
[FindAllAsync](user_findallasync_326280522.md), [FindAllAsync(UserType, UserAuthenticationStatus)](user_findallasync_1333355945.md)

windows.system/user_getfromid_2093276151.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ The Id of the user to get.
2020
The user with the given Id.
2121

2222
## -remarks
23+
If no user with the given *nonRoamableId* is found, this method returns **null**. Always check the return value before using it.
24+
25+
A *nonRoamableId* can be obtained from the [NonRoamableId](user_nonroamableid.md) property of a [User](user.md) object. This identifier is device-specific and is not roamed to other devices.
2326

2427
## -examples
2528

0 commit comments

Comments
 (0)