Show-Command

參考

模組:: Microsoft.PowerShell.Utility

在圖形視窗中顯示PowerShell命令資訊。

Syntax

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

Description

此 Cmdlet 僅適用於 Windows 平臺。

Cmdlet Show-Command 可讓您在命令視窗中建立 PowerShell 命令。您可以使用命令視窗的功能來執行命令，或讓它向您傳回命令。

Show-Command 是非常有用的教學和學習工具。 Show-Command 適用於所有命令類型，包括 Cmdlet、函式、工作流程和 CIM 命令。

如果沒有參數， Show-Command 會顯示命令視窗，其中列出所有已安裝模組中的所有可用命令。若要尋找模組中的命令，請從模組下拉式清單中選取模組。若要選取命令，請按一下命令名稱。

若要使用命令視窗，請使用 [名稱] 或按下 [ 命令 ] 列表中的命令名稱，選取命令。每個參數集都會顯示在個別索引標籤上。星號表示必要參數。若要輸入參數值，請在文字方塊中輸入值，或從下拉式清單方塊中選取值。若要新增切換參數，請按一下參數核取方塊來加以選取。

當您準備好時，您可以按一下 Copy 來將您已經建立的命令複製到剪貼簿或按一下 Run 來執行命令。您也可以使用 PassThru 參數，將命令傳回主機程式，例如 PowerShell 控制台。若要取消命令選取專案並返回顯示所有命令的檢視，請按 Ctrl 並按下選取的命令。

在 PowerShell 整合式腳本環境 (ISE) 中，預設會顯示窗口的變化 Show-Command 。如需使用此命令視窗的相關信息，請參閱 PowerShell ISE 說明主題。

此 Cmdlet 已在 PowerShell 7 中重新引進。

由於此 Cmdlet 需要使用者介面，因此無法在 Windows Server Core 或 Windows Nano Server 上運作。此 Cmdlet 僅適用於支援 Windows 桌面的 Windows 系統上。

範例

範例 1：開啟 [命令] 視窗

這個範例會顯示視窗的預設檢視 Show-Command 。 [ 命令 ] 視窗會顯示電腦上安裝之所有模組中所有命令的清單。

Show-Command

範例 2：在 [命令] 視窗中開啟 Cmdlet

本範例會在 Invoke-Command[命令 ] 視窗中顯示 Cmdlet。您可以使用此顯示來執行 Invoke-Command 命令。

Show-Command -Name "Invoke-Command"

範例 3：使用指定的參數開啟 Cmdlet

此命令會開啟 Show-Command Cmdlet 的Connect-PSSession視窗。

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

Height 和 Width 參數會指定命令視窗的維度。 ErrorPopup 參數會顯示錯誤命令視窗。

當您按兩下 [ 執行] 時，命令會 Connect-PSSession 執行，就像您在命令行輸入 Connect-PSSession 命令一樣。

範例 4：指定 Cmdlet 的新預設參數值

這個範例會 $PSDefaultParameterValues 使用自動變數來設定 Cmdlet 之 Height、 Width 和 ErrorPopup 參數 Show-Command 的新預設值。

$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 Cmdlet。

Show-Command Get-ChildItem | Out-GridView

此命令會 Show-Command 使用 Cmdlet 來開啟 Cmdlet 的Get-ChildItem命令視窗。當您按 鍵按鍵 時，命令會 Get-ChildItem 執行並產生輸出。管線運算子 ( |) 會將命令的 Get-ChildItem 輸出傳送至 Out-GridView Cmdlet，以在互動式視窗中顯示 Get-ChildItem 輸出。

範例 6：顯示您在 [命令] 視窗中建立的命令

這個範例顯示您在視窗中建立的 Show-Command 命令。此命令會使用 PassThru 參數，以傳回 Show-Command 字串中的結果。

Show-Command -PassThru

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

例如，如果您使用Show-Command視窗來建立Get-EventLog命令，以取得 Windows PowerShell 事件記錄檔中的五個最新事件，然後按兩下 [確定]，此命令會傳回上面顯示的輸出。檢視命令字串可協助您瞭解PowerShell。

範例 7：將命令儲存至變數

此範例示範如何使用 Cmdlet 的 PassThru 參數來執行您取得的 Show-Command 命令字串。這項策略可讓您看到命令並使用命令。

$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. ...

第一個命令會使用 Cmdlet 的 Show-CommandPassThru 參數，並將命令的結果儲存在變數中$C。在此情況下，我們會使用 Show-Command 視窗來建立Get-EventLog命令，以取得 Windows PowerShell 事件記錄檔中的五個最新事件。當您按兩下 [確定] 時， 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

指出 Cmdlet 除了在命令行上顯示錯誤之外，還會在彈出視窗中顯示錯誤。根據預設，當視窗中執行的 Show-Command 命令產生錯誤時，錯誤只會顯示在命令行上。

此外，當您使用視窗中的 [ 執行 ] 按鈕 Show-Command) 執行命令 (時， ErrorPopup 參數會將命令結果傳回至目前的命令，而不是執行命令，並將其輸出傳回至新的命令。您可以使用這項功能將命令結果儲存在變數中。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Height

以像素指定視窗的高度 Show-Command 。輸入一個介於 300 和螢幕解析度像素數目之間的值。如果值太大而無法在螢幕上顯示命令視窗， Show-Command 則會產生錯誤。預設高度為 600 像素。 Show-Command對於包含 Name 參數的命令，預設高度為 300 像素。

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

顯示指定命令的命令視窗。輸入一個命令的名稱，例如 Cmdlet、函式或 CIM 命令的名稱。如果您省略此參數，會顯示命令視窗， Show-Command 其中列出計算機上安裝的所有模組中的所有 PowerShell 命令。

Type:	String
Aliases:	CommandName
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoCommonParameter

表示此 Cmdlet 省略命令顯示的 [一般參數] 區段。根據預設，一般參數會出現在命令視窗底部的可展開區段中。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

傳回代表您正在使用之項目的物件。根據預設，此 Cmdlet 不會產生任何輸出。若要執行命令字串，請將它複製並貼到命令提示字元，或將它儲存在變數中，並使用 Invoke-Expression Cmdlet 在變數中執行字串。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Width

以像素指定視窗的 Show-Command 寬度。輸入一個介於 300 和螢幕解析度像素數目之間的值。如果值太大而無法在螢幕上顯示命令視窗， Show-Command 則會產生錯誤。預設寬度為 300 像素。

Type:	Double
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

None

您無法使用管線將輸入傳送至 Show-Command。

輸出

None, System.String, System.Object

當您使用 PassThru 參數時， Show-Command 會傳回命令字串。當您使用 ErrorPopup 參數時， Show-Command 傳回命令輸出 (任何物件) 。否則， Show-Command 不會產生任何輸出。

備註

此 Cmdlet 僅適用於 Windows 平臺。

Show-Command 無法在遠端會話中運作。

共用方式為