Skip to content

Commit e78b999

Browse files
Merge pull request #5002 from MicrosoftDocs/alvinashcraft/main-update-settings-uri-parameters
Update Settings URIs parameter info and re-organize some URIs and sections
2 parents 55c3aea + 83162f9 commit e78b999

File tree

1 file changed

+30
-31
lines changed

1 file changed

+30
-31
lines changed

uwp/launch-resume/launch-settings-app.md

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,31 @@
11
---
22
title: Launch the Windows Settings app
3-
description: Learn how to launch the Windows Settings app from your app using the ms-settings URI scheme.
3+
description: Learn how to launch the Windows Settings app from your own Windows apps using the ms-settings URI scheme.
44
ms.assetid: C84D4BEE-1FEE-4648-AD7D-8321EAC70290
5-
ms.date: 07/24/2024
6-
ms.topic: article
7-
keywords: windows 10, uwp
5+
ms.date: 11/27/2024
6+
ms.topic: concept-article
7+
keywords: windows 10, windows, settings, windows 11, uwp, uri
88
ms.localizationpriority: medium
99
dev_langs:
1010
- csharp
1111
- cppwinrt
12+
# Customer intent: As a Windows developer, I want to learn how to launch the Windows Settings app from my app using the ms-settings URI scheme.
1213
---
1314

1415
# Launch the Windows Settings app
1516

16-
**Important APIs**
17+
Learn how to launch the Windows Settings app. This topic describes the `ms-settings:` URI scheme. Use this URI scheme to launch the Windows Settings app to specific settings pages.
18+
19+
Launching to the Settings app is an important part of writing a privacy-aware app. If your app can't access a sensitive resource, we recommend providing the user a convenient link to the privacy settings for that resource. For more information, see [Guidelines for privacy-aware apps](../security/index.md).
20+
21+
## Important APIs
22+
23+
The following Windows Runtime (WinRT) APIs are used in this topic:
1724

1825
- [**LaunchUriAsync**](/uwp/api/windows.system.launcher.launchuriasync)
1926
- [**PreferredApplicationPackageFamilyName**](/uwp/api/windows.system.launcheroptions.preferredapplicationpackagefamilyname)
2027
- [**DesiredRemainingView**](/uwp/api/windows.system.launcheroptions.desiredremainingview)
2128

22-
Learn how to launch the Windows Settings app. This topic describes the `ms-settings:` URI scheme. Use this URI scheme to launch the Windows Settings app to specific settings pages.
23-
24-
Launching to the Settings app is an important part of writing a privacy-aware app. If your app can't access a sensitive resource, we recommend providing the user a convenient link to the privacy settings for that resource. For more info, see [Guidelines for privacy-aware apps](../security/index.md).
25-
2629
## How to launch the Settings app
2730

2831
To launch the **Settings** app, use the `ms-settings:` URI scheme as shown in the following examples.
@@ -45,7 +48,7 @@ In this example, a Hyperlink XAML control is used to launch the privacy settings
4548

4649
### Calling LaunchUriAsync
4750

48-
Alternatively, your app can call the [**LaunchUriAsync**](/uwp/api/windows.system.launcher.launchuriasync) method to launch the **Settings** app. This example shows how to launch to the privacy settings page for the camera using the `ms-settings:privacy-webcam` URI.
51+
Alternatively, your app can call the [LaunchUriAsync](/uwp/api/windows.system.launcher.launchuriasync) method to launch the **Settings** app. This example shows how to launch to the privacy settings page for the camera using the `ms-settings:privacy-webcam` URI.
4952

5053
```cs
5154
bool result = await Windows.System.Launcher.LaunchUriAsync(new Uri("ms-settings:privacy-webcam"));
@@ -57,7 +60,7 @@ bool result = co_await Windows::System::Launcher::LaunchUriAsync(Windows::Founda
5760

5861
The code above launches the privacy settings page for the camera:
5962

60-
:::image type="content" source="images/privacyawarenesssettingsapp.png" alt-text="camera privacy settings.":::
63+
:::image type="content" source="images/privacyawarenesssettingsapp.png" alt-text="A screenshot of the Windows camera privacy settings.":::
6164

6265
For more info about launching URIs, see [Launch the default app for a URI](launch-default-app.md).
6366

@@ -85,10 +88,9 @@ The following sections describe different categories of ms-settings URIs used to
8588
- [System](#system)
8689
- [Time and language](#time-and-language)
8790
- [Update and security](#update-and-security)
88-
- [User accounts](#user-accounts)
8991

9092
> [!NOTE]
91-
> The availability of some settings pages varies by Windows version and SKU. The notes column also captures additional requirements that must be met for a page to be available.
93+
> The availability of some settings pages varies by Windows version and SKU. For some settings, the URI column also captures some usage information and any additional requirements that must be met for a page to be available.
9294
9395
### Accounts
9496

@@ -97,9 +99,12 @@ The following sections describe different categories of ms-settings URIs used to
9799
| Access work or school | ms-settings:workplace |
98100
| Email & app accounts | ms-settings:emailandaccounts |
99101
| Family & other people | ms-settings:otherusers |
102+
| Provisioning | ms-settings:provisioning (only available on mobile and if the enterprise has deployed a provisioning package)<br>ms-settings:workplace-provisioning (only available if enterprise has deployed a provisioning package) |
103+
| Repair token | ms-settings:workplace-repairtoken |
100104
| Set up a kiosk | ms-settings:assignedaccess |
101105
| Sign-in options | ms-settings:signinoptions<br>ms-settings:signinoptions-dynamiclock |
102106
| Sync your settings | ms-settings:sync<br>ms-settings:backup (**Backup page deprecated in Windows 11**) |
107+
| Windows Anywhere | ms-settings:windowsanywhere (device must be Windows Anywhere-capable) |
103108
| Windows Hello setup | ms-settings:signinoptions-launchfaceenrollment<br>ms-settings:signinoptions-launchfingerprintenrollment |
104109
| Your info | ms-settings:yourinfo |
105110

@@ -108,7 +113,7 @@ The following sections describe different categories of ms-settings URIs used to
108113
|Settings page| URI |
109114
|-------------|-----|
110115
| Apps & Features | ms-settings:appsfeatures |
111-
| App features | ms-settings:appsfeatures-app (Reset, manage add-on & downloadable content, etc. for the app) <br><br> To access this page with a URI, use the ms-settings:appsfeatures-app URI and pass an optional parameter of the _package family name_ of the app. |
116+
| App features | ms-settings:appsfeatures-app (Reset, manage add-on & downloadable content, etc. for the app) <br><br> To access this page with a URI, use the ms-settings:appsfeatures-app URI and pass an optional parameter of the *package family name* of the app.<br><br>Example: `ms-settings:appsfeatures-app?<PFN>` |
112117
| Apps for websites | ms-settings:appsforwebsites |
113118
| Default apps | ms-settings:defaultapps (**Behavior introduced in Windows 11, version 21H2 (with 2023-04 Cumulative Update) or 22H2 (with 2023-04 Cumulative Update), or later.**)<br/>Append the query string parameter in the following formats using the Uri-escaped name of an app to directly launch the default settings page for that app:<br/><br/>- registeredAppMachine=\<Uri-escaped per machine installed name of app\><br/>- registeredAppUser=\<Uri-escaped per user installed name of app\><br/>- registeredAUMID=\<Uri-escaped Application User Model ID\><br/><br/>For more information, see [Launch the Default Apps settings page](launch-default-apps-settings.md). |
114119
| Default browser settings | ms-settings:defaultbrowsersettings (**Deprecated in Windows 11**) |
@@ -168,7 +173,6 @@ The following sections describe different categories of ms-settings URIs used to
168173
| Color filters | ms-settings:easeofaccess-colorfilter </br> ms-settings:easeofaccess-colorfilter-adaptivecolorlink </br> ms-settings:easeofaccess-colorfilter-bluelightlink |
169174
| Display | ms-settings:easeofaccess-display |
170175
| Eye control | ms-settings:easeofaccess-eyecontrol |
171-
| Fonts | ms-settings:fonts |
172176
| High contrast | ms-settings:easeofaccess-highcontrast |
173177
| Keyboard | ms-settings:easeofaccess-keyboard |
174178
| Magnifier | ms-settings:easeofaccess-magnifier |
@@ -206,6 +210,11 @@ The following sections describe different categories of ms-settings URIs used to
206210
> [!NOTE]
207211
> These settings are only available if the [Mixed Reality Portal](https://apps.microsoft.com/detail/9ng1h8b3zc7m) app is installed.
208212
213+
> [!IMPORTANT]
214+
> Windows Mixed Reality devices are not supported with Windows 11, version 24H2 and newer.
215+
>
216+
> Windows Mixed Reality support is limited to Windows 10, version 20H2 through Windows 11, version 23H2.
217+
209218
| Settings page | URI |
210219
|---------------|-----|
211220
| Audio and speech | ms-settings:holographic-audio |
@@ -241,6 +250,7 @@ The following sections describe different categories of ms-settings URIs used to
241250
| Colors | ms-settings:personalization-colors<br/>ms-settings:colors |
242251
| Customize Copilot key on keyboard | ms-settings:personalization-textinput-copilot-hardwarekey |
243252
| Dynamic Lighting | ms-settings:personalization-lighting |
253+
| Fonts | ms-settings:fonts |
244254
| Glance | ms-settings:personalization-glance (**Deprecated in Windows 10, version 1809 and later**) |
245255
| Lock screen | ms-settings:lockscreen |
246256
| Navigation bar | ms-settings:personalization-navbar (**Deprecated in Windows 10, version 1809 and later**) |
@@ -268,7 +278,7 @@ The following sections describe different categories of ms-settings URIs used to
268278
| Advertising ID | ms-settings:privacy-advertisingid (**Deprecated in Windows 10, version 1809 and later**) |
269279
| App diagnostics | ms-settings:privacy-appdiagnostics |
270280
| Automatic file downloads | ms-settings:privacy-automaticfiledownloads |
271-
| Background Apps | ms-settings:privacy-backgroundapps (**Deprecated in Windows 11, 21H2 and later**) <br><br> **Note:** In Windows 11, the background app permissions are accessed individually. To view the permissions, go to **Apps->Installed apps** and then select **"..."** on a modern app and choose **Advanced options**. The advanced page is present for modern apps, and the **Background apps permissions** section will be present unless a group policy has been set or the user’s global toggle value (the deprecated setting from Windows 10) is set. To access this page with a URI, use the `ms-settings:appsfeatures-app` URI and pass an optional parameter of the _package family name_ of the app. |
281+
| Background Apps | ms-settings:privacy-backgroundapps (**Deprecated in Windows 11, 21H2 and later**) <br><br> **Note:** In Windows 11, the background app permissions are accessed individually. To view the permissions, go to **Apps->Installed apps** and then select **"..."** on a modern app and choose **Advanced options**. The advanced page is present for modern apps, and the **Background apps permissions** section will be present unless a group policy has been set or the user’s global toggle value (the deprecated setting from Windows 10) is set. To access this page with a URI, use the `ms-settings:appsfeatures-app` URI and pass an optional parameter of the *package family name* of the app. |
272282
| Background Spatial Perception | ms-settings:privacy-backgroundspatialperception |
273283
| Calendar | ms-settings:privacy-calendar |
274284
| Call history | ms-settings:privacy-callhistory |
@@ -338,9 +348,8 @@ The following sections describe different categories of ms-settings URIs used to
338348
| Battery Saver settings | ms-settings:batterysaver-settings (only available on devices that have a battery, such as a tablet) |
339349
| Battery use | ms-settings:batterysaver-usagedetails (only available on devices that have a battery, such as a tablet) |
340350
| Clipboard | ms-settings:clipboard |
341-
| Display | ms-settings:display |
342351
| Default Save Locations | ms-settings:savelocations |
343-
| Display | ms-settings:screenrotation |
352+
| Display | ms-settings:display<br>ms-settings:screenrotation |
344353
| Duplicating my display | ms-settings:quietmomentspresentation |
345354
| During these hours | ms-settings:quietmomentsscheduled |
346355
| Encryption | ms-settings:deviceencryption |
@@ -375,9 +384,6 @@ The following sections describe different categories of ms-settings URIs used to
375384
| Pinyin IME settings | ms-settings:regionlanguage-chsime-pinyin (available if the Microsoft Pinyin input method editor is installed)</br>ms-settings:regionlanguage-chsime-pinyin-domainlexicon<br/>ms-settings:regionlanguage-chsime-pinyin-keyconfig<br/>ms-settings:regionlanguage-chsime-pinyin-udp |
376385
| Speech | ms-settings:speech |
377386
| Wubi IME settings | ms-settings:regionlanguage-chsime-wubi (available if the Microsoft Wubi input method editor is installed) |
378-
| Add display language | ms-settings:regionlanguage-adddisplaylanguage |
379-
| Language options | ms-settings:regionlanguage-languageoptions |
380-
| Set display language | ms-settings:regionlanguage-setdisplaylanguage |
381387

382388
### Update and security
383389

@@ -401,15 +407,8 @@ The following sections describe different categories of ms-settings URIs used to
401407
| Windows Update-Seeker on demand| ms-settings:windowsupdate-seekerondemand |
402408
| Windows Update-View update history | ms-settings:windowsupdate-history |
403409

404-
### User accounts
405-
406-
|Settings page| URI |
407-
|-------------|-----|
408-
| Provisioning | ms-settings:workplace-provisioning (only available if enterprise has deployed a provisioning package) |
409-
| Repair token | ms-settings:workplace-repairtoken |
410-
| Provisioning | ms-settings:provisioning (only available on mobile and if the enterprise has deployed a provisioning package) |
411-
| Windows Anywhere | ms-settings:windowsanywhere (device must be Windows Anywhere-capable) |
412-
413-
## See also
410+
## Related content
414411

415412
[Launch the default app for a URI](launch-default-app.md)
413+
414+
[Launching, resuming, and background tasks](index.md)

0 commit comments

Comments
 (0)