次の方法で共有

Show-Command

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

PowerShell コマンド情報をグラフィカル ウィンドウに表示します。

構文

Show-Command
    [[-Name] <String>]
    [-Height <Double>]
    [-Width <Double>]
    [-NoCommonParameter]
    [-ErrorPopup]
    [-PassThru]
    [<CommonParameters>]

説明

Show-Command コマンドレットを使用すると、コマンド ウィンドウで PowerShell コマンドを作成できます。 コマンド ウィンドウの機能を使用してコマンドを実行するか、コマンドを返すことができます。

Show-Command は非常に便利な教育と学習ツールです。 Show-Command は、コマンドレット、関数、ワークフロー、CIM コマンドなど、すべてのコマンドの種類で機能します。

パラメーターがない場合、Show-Command は、インストールされているすべてのモジュールで使用可能なすべてのコマンドを一覧表示するコマンド ウィンドウを表示します。 モジュール内のコマンドを見つけるには、[モジュール] ドロップダウン リストからモジュールを選択します。 コマンドを選択するには、コマンド名をクリックします。

コマンド ウィンドウを使用するには、[名前] を使用するか、[コマンド] 一覧でコマンド名をクリックして、コマンドを選択します。 各パラメーター セットは、個別のタブに表示されます。アスタリスクは必須パラメーターを示します。 パラメーターの値を入力するには、テキスト ボックスに値を入力するか、ドロップダウン ボックスから値を選択します。 スイッチ パラメーターを追加するには、クリックしてパラメーター のチェック ボックスをオンにします。

準備ができたら、[コピー] をクリックして、作成したコマンドをクリップボードにコピーするか、[ 実行] をクリックしてコマンドを実行できます。 PassThru パラメーターを使用して、PowerShell コンソールなどのホスト プログラムにコマンドを返すこともできます。 コマンドの選択を取り消し、すべてのコマンドを表示するビューに戻すには、Ctrl キーを押して選択したコマンドをクリックします。

PowerShell Integrated Scripting Environment (ISE) では、Show-Command ウィンドウのバリエーションが既定で表示されます。 このコマンド ウィンドウの使用方法については、PowerShell ISE のヘルプ トピックを参照してください。

このコマンドレットは、PowerShell 3.0 で導入されました。

このコマンドレットにはユーザー インターフェイスが必要であるため、Windows Server Core または Windows Nano Server では機能しません。 このコマンドレットは、Windows デスクトップをサポートする Windows システムでのみ使用できます。

例

例 1: コマンド ウィンドウを開く

次の使用例は、Show-Command ウィンドウの既定のビューを表示します。 コマンド ウィンドウには、コンピューターにインストールされているすべてのモジュールのすべてのコマンドの一覧が表示されます。

Show-Command

例 2: コマンド ウィンドウでコマンドレットを開く

次の使用例は、コマンド ウィンドウに Invoke-Command コマンドレットを表示します。 この表示を使用して、Invoke-Command コマンドを実行できます。

Show-Command -Name "Invoke-Command"

例 3: 指定されたパラメーターを使用してコマンドレットを開く

このコマンドを実行すると、Connect-PSSessionコマンドレットの Show-Command ウィンドウが開きます。

Show-Command -Name "Connect-PSSession" -Height 700 -Width 1000 -ErrorPopup

Height パラメーターと Width パラメーターは、コマンド ウィンドウの寸法を指定します。 ErrorPopup パラメーターには、エラー コマンド ウィンドウが表示されます。

[実行] をクリックすると、コマンド ラインで Connect-PSSession コマンドを入力した場合と同様に、Connect-PSSession コマンドが実行されます。

例 4: コマンドレットの新しい既定のパラメーター値を指定する

この例では、$PSDefaultParameterValues 自動変数を使用して、Height、Width、および Show-Command コマンドレット の ErrorPopup パラメーターの新しい既定値を設定します。

$PSDefaultParameterValues = @{
    "Show-Command:Height" = 700
    "Show-Command:Width" = 1000
    "Show-Command:ErrorPopup" = $True
}

Show-Command コマンドを実行すると、新しい既定値が自動的に適用されます。 すべての PowerShell セッションでこれらの既定値を使用するには、$PSDefaultParameterValues 変数を PowerShell プロファイルに追加します。 詳細については、「about_Profiles と about_Parameters_Default_Values」を参照してください。

例 5: グリッド ビューに出力を送信する

このコマンドは、Show-Command コマンドレットと Out-GridView コマンドレットを一緒に使用する方法を示します。

Show-Command Get-ChildItem | Out-GridView

このコマンドでは、Show-Command コマンドレットを使用して、Get-ChildItemコマンドレットのコマンド ウィンドウを開きます。 実行 ボタンをクリックすると、Get-ChildItem コマンドが実行され、出力が生成されます。 パイプライン演算子 ( | ) は、Get-ChildItem コマンドの出力を Out-GridView コマンドレットに送信し、対話型ウィンドウに Get-ChildItem 出力を表示します。

例 6: [コマンド] ウィンドウで作成したコマンドを表示する

この例では、Show-Command ウィンドウで作成したコマンドを示します。 このコマンドでは、PassThru パラメーターを使用します。このパラメーターは、Show-Command 結果を文字列で返します。

Show-Command -PassThru

Get-EventLog -LogName "Windows PowerShell" -Newest 5

たとえば、Show-Command ウィンドウを使用して、Windows PowerShell イベント ログに 5 つの最新のイベントを取得する Get-EventLog コマンドを作成し、[OK] クリックすると、上記の出力が返されます。 コマンド文字列を表示すると、PowerShell を学習するのに役立ちます。

例 7: 変数にコマンドを保存する

この例では、Show-Command コマンドレットの PassThru パラメーターを使用したときに取得するコマンド文字列を実行する方法を示します。 この方法では、コマンドを表示して使用できます。

$C = Show-Command -PassThru
$C
Invoke-Expression $C

Get-EventLog -LogName "PowerShell" -Newest 5

Index Time          EntryType   Source                 InstanceID Message
----- ----          ---------   ------                 ---------- -------
11520 Dec 16 16:37  Information Windows PowerShell            400 Engine state is changed from None to Available...
11519 Dec 16 16:37  Information Windows PowerShell            600 Provider "Variable" is Started. ...
11518 Dec 16 16:37  Information Windows PowerShell            600 Provider "Registry" is Started. ...
11517 Dec 16 16:37  Information Windows PowerShell            600 Provider "Function" is Started. ...
11516 Dec 16 16:37  Information Windows PowerShell            600 Provider "FileSystem" is Started. ...

最初のコマンドでは、Show-Command コマンドレットの PassThru パラメーターを使用し、コマンドの結果を $C 変数に保存します。 この場合は、Show-Command ウィンドウを使用して、Windows PowerShell イベント ログの最新の 5 つのイベントを取得する Get-EventLog コマンドを作成します。 [OK] クリックすると、Show-Command コマンド文字列が返されます。コマンド文字列は、$C 変数に保存されます。

例 8: コマンドの出力を変数に保存する

この例では、ErrorPopup パラメーターを使用して、コマンドの出力を変数に保存します。

$P = Show-Command Get-Process -ErrorPopup
$P

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    473      33    94096     112532   709     2.06   4492 powershell

エラーをウィンドウに表示するだけでなく、ErrorPopup は、新しいコマンドを作成するのではなく、現在のコマンドにコマンド出力を返します。 このコマンドを実行すると、Show-Command ウィンドウが開きます。 ウィンドウ機能を使用して、パラメーター値を設定できます。 コマンドを実行するには、Show-Command ウィンドウの [実行] ボタンをクリックします。

パラメーター

-ErrorPopup

コマンド ラインにエラーを表示するだけでなく、コマンドレットがポップアップ ウィンドウにエラーを表示することを示します。 既定では、Show-Command ウィンドウで実行されるコマンドでエラーが生成された場合、エラーはコマンド ラインにのみ表示されます。

また、コマンドを実行すると (Show-Command ウィンドウの ボタンを使用して)、ErrorPopup パラメーターは、コマンドを実行してその出力を新しいコマンドに返すのではなく、コマンドの結果を現在のコマンドに返します。 この機能を使用して、コマンドの結果を変数に保存できます。

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Height

Show-Command ウィンドウの高さをピクセル単位で指定します。 300 から画面解像度のピクセル数までの値を入力します。 値が大きすぎてコマンド ウィンドウを画面に表示するには、Show-Command エラーが発生します。 既定の高さは 600 ピクセルです。 Name パラメーターを含む Show-Command コマンドの場合、既定の高さは 300 ピクセルです。

型:Double
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Name

指定したコマンドのコマンド ウィンドウを表示します。 コマンドレット、関数、CIM コマンドの名前など、1 つのコマンドの名前を入力します。 このパラメーターを省略 Show-Command、コンピューターにインストールされているすべてのモジュールのすべての PowerShell コマンドを一覧表示するコマンド ウィンドウが表示されます。

型:String
Aliases:CommandName
配置:0
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-NoCommonParameter

このコマンドレットがコマンド表示の [共通パラメーター] セクションを省略することを示します。 既定では、共通パラメーターは、コマンド ウィンドウの下部にある展開可能なセクションに表示されます。

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-PassThru

作業中のアイテムを表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。 コマンド文字列を実行するには、コマンド プロンプトでコピーして貼り付けるか、変数に保存し、Invoke-Expression コマンドレットを使用して変数内の文字列を実行します。

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Width

Show-Command ウィンドウの幅をピクセル単位で指定します。 300 から画面解像度のピクセル数までの値を入力します。 値が大きすぎてコマンド ウィンドウを画面に表示するには、Show-Command エラーが発生します。 既定の幅は 300 ピクセルです。

型:Double
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

None

既定では、このコマンドレットは出力を返しません。

String

PassThru パラメーターを使用すると、このコマンドレットはコマンド文字列を返します。

Object

ErrorPopup パラメーターを使用すると、このコマンドレットはコマンド出力 (任意のオブジェクト) を返します。

メモ

Windows PowerShell には、Show-Commandの次のエイリアスが含まれています。

  • shcm

Show-Command はリモート セッションでは機能しません。