Format-Custom
使用自訂檢視來格式化輸出。
語法
Format-Custom [[-Property] <Object[]>] [-Depth <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
描述
Format-Custom Cmdlet 會按照替代檢視中定義的方式,格式化命令的輸出。Format-Custom 是專為顯示純粹表格或純粹清單以外的檢視而設計。您可以使用 Windows PowerShell 目錄中 *format.PS1XML 檔案所定義的檢視,也可以在新的 PS1XML 檔案中自行建立檢視,再使用 Update-FormatData Cmdlet 將所建立的檢視加入至 Windows PowerShell。
參數
-Depth <int>
指定畫面上顯示的欄數。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-DisplayError
在命令列顯示錯誤。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-Expand <string>
將集合物件連同集合中的物件一併格式化。此參數係設計為對支援 ICollection (System.Collections) 介面的物件進行格式化。預設值為 EnumOnly。
有效的值包括:
-- EnumOnly:顯示集合中各物件的屬性。
-- CoreOnly:顯示集合物件的屬性。
-- Both:顯示集合物件的屬性,以及集合中各物件的屬性。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-Force
指示 Cmdlet 顯示所有的錯誤資訊。請與 DisplayError 或 ShowError 參數搭配使用。根據預設,當錯誤物件寫入錯誤或顯示的資料流時,只會顯示一部分的錯誤資訊。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-GroupBy <Object>
依據共用屬性或值,將輸出格式化為群組。請輸入運算式或指定輸出的屬性。
GroupBy 參數的值可以是新的計算屬性。若要建立計算屬性,請使用雜湊表。有效的索引鍵包括:
-- Name (或 Label) <字串>
-- Expression <字串> 或 <指令碼區塊>
-- FormatString <字串>
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-InputObject <psobject>
指定要格式化的物件。請輸入包含物件的變數,或輸入可取得物件的命令或運算式。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
true (ByValue) |
接受萬用字元? |
false |
-Property <Object[]>
指定呈現在畫面上的物件屬性及其呈現的順序。允許使用萬用字元。
如果省略此參數,呈現在畫面上的屬性將依所顯示的物件而定。參數名稱 ("Property") 為選擇項。同一個命令不能同時使用 Property 和 View 參數。
Property 參數的值可以是新的計算屬性。若要建立計算屬性,請使用雜湊表。有效的索引鍵包括:
-- Expression <字串> 或 <指令碼區塊>
-- Depth <int32>
必要? |
false |
位置? |
1 |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-ShowError
透過管線傳送錯誤。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-View <string>
指定替代格式或「檢視」的名稱。如果省略此參數,Format-Custom 會使用預設的自訂檢視。同一個命令不能同時使用 Property 和 View 參數。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
<CommonParameters>
這個 Cmdlet 支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_Commonparameters.
輸入和輸出
輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。
輸入 |
System.Management.Automation.PSObject 您可經由管道將任何物件輸出至 Format-Custom |
輸出 |
Microsoft.PowerShell.Commands.Internal.Format Format-Custom 會傳回代表顯示的格式物件。 |
附註
Format-Custom 是專為顯示純粹表格或純粹清單以外的檢視而設計。若要顯示替代表格檢視,請使用 Format-Table。若要顯示替代清單檢視,請使用 Format-List。
您也可以利用內建的別名 "fc" 來參照 Format-Custom。如需詳細資訊,請參閱 about_Aliases。
GroupBy 參數會假設物件已經過排序。在使用 Format-Custom 將物件分組之前,請先使用 Sort-Object 將物件排序。
範例 1
C:\PS>get-command start-transcript | format-custom -view MyView
描述
-----------
這個命令使用 MyView 檢視 (使用者建立的自訂檢視) 定義的格式,將有關 Start-Transcript Cmdlet 的資訊格式化。若要成功執行這個命令,必須先建立新的 PS1XML 檔案、定義 MyView 檢視,然後使用 Update-FormatData 命令將 PS1XML 檔案加入至 Windows PowerShell。
範例 2
C:\PS>get-process Winlogon | format-custom
描述
-----------
這個命令會以替代的自訂檢視來格式化 Winlogon 處理序的資訊。因為此命令沒有使用 View 參數,所以 Format-Custom 使用預設的自訂檢視來格式化資料。