WESL_UserSetting.SetCustomShell
このメソッドは、セキュリティ識別子 (SID) に基づいて、特定のユーザーまたはグループ用にシェル ランチャーを構成します。
構文
[Static] uint32 SetCustomShell (
[In, Required] string Sid,
[In, Required] string Shell,
[In] sint32 CustomReturnCodes[],
[In] sint32 CustomReturnCodesAction[],
[In] sint32 DefaultAction
);
パラメーター
Sid
[入力、必須] シェル ランチャーの構成対象となるユーザーまたはグループのセキュリティ識別子 (SID) を表す文字列。
Shell
[入力、必須] シェル ランチャーによってシェルとして起動されるアプリケーションまたは実行可能ファイル。
CustomReturnCodes
[入力] シェル アプリケーションから返される可能性のあるカスタム リターン コードの配列。
CustomReturnCodesAction
[入力] シェル アプリケーションの終了時にシェル ランチャーによって実行されるアクションを決定するカスタム リターン コード アクションの配列。 カスタム アクションは、CustomReturnCodes の配列にマップされます。
実行可能なアクションの定義を次の表に示します。
値 | 説明 |
---|---|
0 | シェルを再起動します。 |
1 | デバイスを再起動します。 |
2 | デバイスをシャットダウンします。 |
3 | 何もしない。 |
DefaultAction
[入力] シェル アプリケーションが終了するときにシェル ランチャーによって実行される既定のアクション。
実行可能なアクションの定義を次の表に示します。
値 | 説明 |
---|---|
0 | シェルを再起動します。 |
1 | デバイスを再起動します。 |
2 | デバイスをシャットダウンします。 |
3 | 何もしない。 |
戻り値
WMI の状態または WMI エラーを示す HRESULT 値を返します。
解説
シェル ランチャーは、CustomReturnCodes と CustomReturnCodesAction の配列を使用し、シェル アプリケーションの戻り値に基づいて、シェル アプリケーションが終了したときのシステムの動作を決定します。
CustomReturnCodes に戻り値が存在しなかった場合や、CustomReturnCodesAction に定義された対応するアクションが有効な値ではなかった場合は、DefaultAction を使用してシステムの動作が決まります。 DefaultAction が定義されなかった場合や有効な値ではなかった場合は、シェル アプリケーションが再起動されます。
要件
Windows エディション | サポートされています |
---|---|
Windows Home | いいえ |
Windows Pro | いいえ |
Windows Enterprise | はい |
Windows Education | はい |
Windows IoT Enterprise | はい |