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) を含む文字列。

シェル
[入力、必須]シェルランチャーがシェルとして起動するアプリケーションまたは実行可能ファイル。

CustomReturnCodes
[入力]シェル アプリケーションから返すことができるカスタム リターン コードの配列。

CustomReturnCodesAction
[入力]シェル アプリケーションの終了時にシェルランチャーが実行するアクションを決定するカスタムリターンコードアクションの配列。 カスタム アクションは、CustomReturnCodes の配列にマップされます。

実行可能なアクションの定義を次の表に示します。

値	説明
0	シェルを再起動します。
1	デバイスを再起動します。
2	デバイスをシャットダウンします。
3	何もしない。

DefaultAction
[入力]シェル アプリケーションが終了したときにシェル ランチャーが実行する既定のアクション。

実行可能なアクションの定義を次の表に示します。

値	説明
0	シェルを再起動します。
1	デバイスを再起動します。
2	デバイスをシャットダウンします。
3	何もしない。

戻り値

WMI の状態または WMI エラーを示す HRESULT 値を返します。

注釈

シェル ランチャーは、CustomReturnCodes と CustomReturnCodesAction の配列を使用し、シェル アプリケーションの戻り値に基づいて、シェル アプリケーションが終了したときのシステムの動作を決定します。

CustomReturnCodes に戻り値が存在しなかった場合や、CustomReturnCodesAction に定義された対応するアクションが有効な値ではなかった場合は、DefaultAction を使用してシステムの動作が決まります。 DefaultAction が定義されなかった場合や有効な値ではなかった場合は、シェル アプリケーションが再起動されます。

要件

Windows エディション	サポートされています
Windows ホーム	いいえ
Windows Pro	いいえ
Windows Enterprise	はい
Windows Education	はい
Windows IoT Enterprise	はい

関連トピック

• WESL_UserSetting
• シェル ランチャー