Language

User.GetUserAgeRangeAsync Method

Definition

Namespace:
Windows.System
Edit

Retrieves the age range that the current user falls into.

public:
 virtual IAsyncOperation<UserAgeRange ^> ^ GetUserAgeRangeAsync() = GetUserAgeRangeAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<UserAgeRange> GetUserAgeRangeAsync();
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<UserAgeRange> GetUserAgeRangeAsync();
function getUserAgeRangeAsync()
Public Function GetUserAgeRangeAsync () As IAsyncOperation(Of UserAgeRange)

Returns

IAsyncOperation<UserAgeRange>

An asynchronous operation that returns a UserAgeRange for the current user, or null when the age range is unknown or unavailable.

Attributes
RemoteAsyncAttribute

Windows requirements

Requirements Description
Device family
Windows 11, version 24H2 (introduced in 10.0.26100.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v19.0)
App capabilities
userAccountInformation

Examples

#include <winrt/Windows.Foundation.h>
#include <winrt/Windows.System.h>

using namespace winrt;
using namespace winrt::Windows::System;

int wmain()
{
    init_apartment();

    User user = User::GetDefault();
    UserAgeRange range = user.GetUserAgeRangeAsync().get();

    if (range)
    {
        int32_t lower = range.Lower();
        int32_t upper = range.Upper();

        // Use the inclusive age bucket.
    }
    else
    {
        // Use the app's fallback experience.
    }
}

User user = User.GetDefault();
UserAgeRange range = await user.GetUserAgeRangeAsync();

if (range != null)
{
    int lower = range.Lower;
    int upper = range.Upper;

    // Use the inclusive age bucket.
}
else
{
    // Use the app's fallback experience.
}

Remarks

UserAgeRange.Lower and UserAgeRange.Upper are inclusive bounds.

Age group Lower Upper
Under 10 0 9
10-12 10 12
13-15 13 15
16-17 16 17
18 or older 18 INT32_MAX

The operation returns null when the user's age isn't known, the feature is unavailable, or the APIs are disabled by administrative policy. A null result is an expected outcome and must not be treated as an exact age or as the 18-or-older range.

  • Call this method on the User object for the user running the current process. Use User.GetDefault to obtain that user directly.
  • The app package must declare the userAccountInformation capability. A caller without access, or a caller using a User object for a different user, can receive E_ACCESSDENIED.
  • This method returns an age bucket, not the user's exact age or date of birth.
  • In C++/WinRT, call .get() from a suitable non-UI thread or use co_await from a coroutine.

Administrative policy

Administrators can disable the Digital Safety age APIs or configure a default age group through Group Policy or MDM. When the APIs are disabled, this method returns null. When a default age group is configured, this method returns the UserAgeRange that corresponds to that group.

Applies to

See also