mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-12 13:27:23 +00:00
78 lines
2.7 KiB
Markdown
78 lines
2.7 KiB
Markdown
---
|
|
title: WESL_UserSetting.GetCustomShell
|
|
description: WESL_UserSetting.GetCustomShell
|
|
ms.date: 05/20/2024
|
|
ms.topic: reference
|
|
---
|
|
|
|
# WESL_UserSetting.GetCustomShell
|
|
|
|
This method retrieves the Shell Launcher configuration for a specific user or group, based on the security identifier (SID).
|
|
|
|
## Syntax
|
|
|
|
```powershell
|
|
[Static] uint32 GetCustomShell (
|
|
[In, Required] string Sid,
|
|
[Out, Required] string Shell,
|
|
[Out, Required] sint32 CustomReturnCodes[],
|
|
[Out, Required] sint32 CustomReturnCodesAction[],
|
|
[Out, Required] sint32 DefaultAction
|
|
);
|
|
```
|
|
|
|
## Parameters
|
|
|
|
**Sid**</br>\[in, required\] A string containing the security identifier (SID) of the user or group that Shell Launcher is configured for.
|
|
|
|
**Shell**</br>\[out, required\] The application or executable that Shell Launcher starts as the shell.
|
|
|
|
**CustomReturnCodes**</br>\[out, required\] An array of custom return codes returned by the shell application.
|
|
|
|
**CustomReturnCodesAction**</br>\[out, required\] An array of custom return code actions that determine the action that Shell Launcher takes when the shell application exits. The custom actions map to the array of *CustomReturnCodes*.
|
|
|
|
The possible actions are defined in the following table:
|
|
|
|
| Value | Description |
|
|
|:-----:|-------------|
|
|
| 0 | Restart the shell. |
|
|
| 1 | Restart the device. |
|
|
| 2 | Shut down the device. |
|
|
| 3 | Do nothing. |
|
|
|
|
**DefaultAction**</br>\[out, required\] The default action that Shell Launcher takes when the shell application exits.
|
|
|
|
The possible actions are defined in the following table:
|
|
|
|
| Value | Description |
|
|
|:------:|-------------|
|
|
| 0 | Restart the shell. |
|
|
| 1 | Restart the device. |
|
|
| 2 | Shut down the device. |
|
|
| 3 | Do nothing. |
|
|
|
|
## 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).
|
|
|
|
## Remarks
|
|
|
|
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)
|