Show-Command

參考

模組:: Microsoft.PowerShell.Utility

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

語法

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

Description

此 Cmdlet 只能在 Windows 平臺上使用。

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

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

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

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

當您準備好時，您可以按下 [複製 ]，將您建立的命令複製到剪貼簿，或按兩下 [執行]，以執行命令。您也可以使用 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

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

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

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

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

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

這個範例會使用 $PSDefaultParameterValues 自動變數，為 Height、Width和 ErrorPopupShow-Command cmdlet 的參數設定新的預設值。

$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 來開啟Get-ChildItemCmdlet 的命令視窗。當您按兩下 [執行] 按鈕時，Get-ChildItem 命令會執行並產生輸出。管線運算子（ | ）會將 Get-ChildItem 命令的輸出傳送至 Out-GridView Cmdlet，此 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：將命令儲存至變數

此範例示範如何使用 Show-Command Cmdlet 的 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 Cmdlet 的 PassThru 參數，並將命令的結果儲存在 $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 參數會將命令結果傳回至目前的命令，而不是執行命令，並將其輸出傳回至新的命令。您可以使用這項功能將命令結果儲存在變數中。

類型:	SwitchParameter
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Height

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

類型:	Double
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Name

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

類型:	String
別名:	CommandName
Position:	0
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-NoCommonParameter

指出這個 Cmdlet 會省略命令顯示的 Common Parameters 區段。根據預設，Common Parameters 會出現在命令視窗底部的可展開區段中。

類型:	SwitchParameter
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-PassThru

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

類型:	SwitchParameter
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Width

以像素為單位指定 Show-Command 視窗的寬度。輸入介於 300 與螢幕解析度中像素數之間的值。如果值太大而無法在螢幕上顯示命令視窗，Show-Command 會產生錯誤。默認寬度為 300 像素。

類型:	Double
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

None

您無法使用管線將物件傳送至此 Cmdlet。

輸出

None

根據預設，此 Cmdlet 不會傳回任何輸出。

String

當您使用 PassThru 參數時，這個 Cmdlet 會傳回命令字串。

Object

當您使用 ErrorPopup 參數時，這個 Cmdlet 會傳回命令輸出（任何物件）。

備註

PowerShell 包含下列 Show-Command別名：

窗戶：
- shcm

此 Cmdlet 僅適用於 Windows 平臺。

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

共用方式為