deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-11 21:07:23 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update reference documentation for shell launcher

Browse Source
This commit is contained in:
Paolo Matarazzo 2025-02-25 11:38:47 -05:00
parent 21ce06baa3
commit a0c9ba79cd
10 changed files with 31 additions and 152 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
includes/licensing/shell-launcher.md
View File

@ -20,14 +20,4 @@ The following table lists the Windows editions that support Shell Launcher:
|IoT Enterprise LTSC|✅|
|Pro Education|❌|
|Pro|❌|
<!--
Shell Launcher license entitlements are granted by the following licenses:
|Windows Pro/Pro Education/SE|Windows Enterprise E3|Windows Enterprise E5|Windows Education A3|Windows Education A5|
|:---:|:---:|:---:|:---:|:---:|
|No|Yes|Yes|Yes|Yes|
For more information about Windows licensing, see [Windows licensing overview](/windows/whats-new/windows-licensing).
-->
|Home|❌|

20
windows/configuration/shell-launcher/wedl-assignedaccess.md
View File

@ -1,14 +1,16 @@
---
title: WEDL\_AssignedAccess
description: WEDL\_AssignedAccess
ms.date: 05/20/2024
title: WEDL_AssignedAccess
description: WEDL_AssignedAccess
ms.date: 02/25/2025
ms.topic: reference
---
# WEDL\_AssignedAccess
# WEDL_AssignedAccess
This Windows Management Instrumentation (WMI) provider class configures settings for assigned access.
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -129,13 +131,3 @@ if ($AssignedAccessConfig) {
"Could not set up assigned access account."
}
```
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |

18
windows/configuration/shell-launcher/wesl-usersetting.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting
description: WESL_UserSetting
ms.date: 05/02/2017
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This class configures which application Shell Launcher starts based on the security identifier (SID) of the signed in user, and also configures the set of return codes and return actions that Shell Launcher performs when the application exits.
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -158,17 +160,3 @@ $ShellLauncherClass.RemoveCustomShell($Admins_SID)
$ShellLauncherClass.RemoveCustomShell($Cashier_SID)
```
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [Shell Launcher](index.md)

19
windows/configuration/shell-launcher/wesl-usersettinggetcustomshell.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting.GetCustomShell
description: WESL_UserSetting.GetCustomShell
ms.date: 05/20/2024
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This method retrieves the Shell Launcher configuration for a specific user or group, based on the security identifier (SID).
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -60,18 +62,3 @@ Returns an HRESULT value that indicates [WMI status](/windows/win32/wmisdk/wmi-n
Shell Launcher uses the *CustomReturnCodes* and *CustomReturnCodesAction* arrays to determine the system behavior when the shell application exits, based on the return value of the application.
If the return value does not exist in *CustomReturnCodes*, or if the corresponding action defined in *CustomReturnCodesAction* is not a valid value, Shell Launcher uses *DefaultAction* to determine system behavior. If *DefaultAction* is not defined, or is not a valid value, Shell Launcher restarts the shell application.
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [WESL_UserSetting](wesl-usersetting.md)
- [Shell Launcher](index.md)

19
windows/configuration/shell-launcher/wesl-usersettinggetdefaultshell.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting.GetDefaultShell
description: WESL_UserSetting.GetDefaultShell
ms.date: 05/20/2024
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This method retrieves the default Shell Launcher configuration.
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -40,18 +42,3 @@ Returns an HRESULT value that indicates [WMI status](/windows/win32/wmisdk/wmi-n
## Remarks
Shell Launcher uses the default configuration when the security identifier (SID) of the user who is currently signed in does not match any custom defined Shell Launcher configurations.
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [WESL_UserSetting](wesl-usersetting.md)
- [Shell Launcher](index.md)

19
windows/configuration/shell-launcher/wesl-usersettingisenabled.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting.IsEnabled
description: WESL_UserSetting.IsEnabled
ms.date: 05/20/2024
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This method retrieves a value that indicates if Shell Launcher is enabled or disabled.
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -24,18 +26,3 @@ This method retrieves a value that indicates if Shell Launcher is enabled or dis
## Return Value
Returns an HRESULT value that indicates [WMI status](/windows/win32/wmisdk/wmi-non-error-constants) or a [WMI error](/windows/win32/wmisdk/wmi-error-constants).
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [WESL_UserSetting](wesl-usersetting.md)
- [Shell Launcher](index.md)

19
windows/configuration/shell-launcher/wesl-usersettingremovecustomshell.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting.RemoveCustomShell
description: WESL_UserSetting.RemoveCustomShell
ms.date: 05/20/2024
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This method removes a Shell Launcher configuration for a specific user or group, based on the security identifier (SID).
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -28,18 +30,3 @@ Returns an HRESULT value that indicates [WMI status](/windows/win32/wmisdk/wmi-n
## Remarks
You must restart your device for the changes to take effect.
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [WESL_UserSetting](wesl-usersetting.md)
- [Shell Launcher](index.md)

19
windows/configuration/shell-launcher/wesl-usersettingsetcustomshell.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting.SetCustomShell
description: WESL_UserSetting.SetCustomShell
ms.date: 05/20/2024
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This method configures Shell Launcher for a specific user or group, based on the security identifier (SID).
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -60,18 +62,3 @@ Returns an HRESULT value that indicates [WMI status](/windows/win32/wmisdk/wmi-n
Shell Launcher uses the *CustomReturnCodes* and *CustomReturnCodesAction* arrays to determine the system behavior when the shell application exits, based on the return value of the shell application.
If the return value does not exist in *CustomReturnCodes*, or if the corresponding action defined in *CustomReturnCodesAction* is not a valid value, Shell Launcher uses *DefaultAction* to determine system behavior. If *DefaultAction* is not defined, or is not a valid value, Shell Launcher restarts the shell application.
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [WESL_UserSetting](wesl-usersetting.md)
- [Shell Launcher](index.md)

19
windows/configuration/shell-launcher/wesl-usersettingsetdefaultshell.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting.SetDefaultShell
description: WESL_UserSetting.SetDefaultShell
ms.date: 05/20/2024
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This method sets the default Shell Launcher configuration.
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -40,18 +42,3 @@ Returns an HRESULT value that indicates [WMI status](/windows/win32/wmisdk/wmi-n
## Remarks
Shell Launcher uses the default configuration when the security identifier (SID) of the user who is currently signed in does not match any custom defined Shell Launcher configurations.
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [WESL_UserSetting](wesl-usersetting.md)
- [Shell Launcher](index.md)

19
windows/configuration/shell-launcher/wesl-usersettingsetenabled.md
View File

@ -1,7 +1,7 @@
---
title: WESL_UserSetting.SetEnabled
description: WESL_UserSetting.SetEnabled
ms.date: 05/20/2024
ms.date: 02/25/2025
ms.topic: reference
---
@ -9,6 +9,8 @@ ms.topic: reference
This method enables or disables Shell Launcher.
[!INCLUDE [shell-launcher](../../../includes/licensing/shell-launcher.md)]
## Syntax
```powershell
@ -30,18 +32,3 @@ Returns an HRESULT value that indicates [WMI status](/windows/win32/wmisdk/wmi-n
This method enables or disables Shell Launcher by modifying the **Shell** value in the registry key `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon`. If Unified Write Filter (UWF) is enabled, you may need to disable UWF or commit this registry key by using [UWF_RegistryFilter.CommitRegistry](../unified-write-filter/uwf-registryfiltercommitregistry.md) in order to enable or disable Shell Launcher.
Enabling or disabling Shell Launcher does not take effect until a user signs in.
## Requirements
| Windows Edition | Supported |
|:-----------------------|:---------:|
| Windows Home | No |
| Windows Pro | No |
| Windows Enterprise | Yes |
| Windows Education | Yes |
| Windows IoT Enterprise | Yes |
## Related topics
- [WESL_UserSetting](wesl-usersetting.md)
- [Shell Launcher](index.md)