Format-List
將輸出格式化成屬性的清單,其中每個屬性都會在新的一行中出現。
語法
Format-List [[-屬性] <Object[]>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
描述
Format-List Cmdlet 將命令的輸出格式化為屬性的清單,其中每個屬性都顯示在個別的一行中。您可以使用 Format-List 將物件的所有或所選屬性格式化並顯示為清單 (format-list *)。
因為每個項目在清單中,比在表格中有更多的空間可用,所以 Windows PowerShell 可在清單中顯示更多的物件屬性,而且屬性值也比較不可能被截斷。
參數
-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 參數的值可以是新的計算屬性。若要建立計算屬性,請使用雜湊表。有效的索引鍵包括:
-- Name (或 Label) <字串>
-- Expression <字串> 或 <指令碼區塊>
-- FormatString <字串>
必要? |
false |
位置? |
1 |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-ShowError
透過管線傳送錯誤。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-View <string>
指定替代清單格式或「檢視」的名稱。同一個命令不能同時使用 Property 和 View 參數。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
<CommonParameters>
這個 Cmdlet 支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_Commonparameters.
輸入和輸出
輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。
輸入 |
System.Management.Automation.PSObject 您可經由管道將任何物件輸出至 Format-List。 |
輸出 |
Microsoft.PowerShell.Commands.Internal.Format Format-List 會傳回代表清單的格式物件。 |
附註
您也可以利用內建的別名 "FL" 來參照 Format-List。如需詳細資訊,請參閱 about_Aliases。
格式 Cmdlet (如 Format-List) 會排列要顯示的資料,但是不會顯示資料。資料是透過 Windows PowerShell 的輸出功能以及包含 Out 動詞 (Out Cmdlet) 的 Cmdlet 顯示出來,例如 Out-Host、Out-File 和 Out-Printer。
如果沒有使用格式 cmdlet,Windows PowerShell 便會為顯示的每個物件套用預設格式。
GroupBy 參數會假設物件已經過排序。在使用 Format-Custom 將物件分組之前,請先使用 Sort-Object 將物件排序。
使用 View 參數可為表格指定替代格式。您可以使用 Windows PowerShell 目錄中 *.format.PS1XML 檔案所定義的檢視,也可以在新的 PS1XML 檔案中自行建立檢視,再使用 Update-FormatData Cmdlet 將所建立的檢視包含在 Windows PowerShell 中。
View 參數的替代檢視必須使用清單格式,否則命令會失敗。如果替代檢視是一份表格,請使用 Format-Table。如果替代檢視既不是清單也不是表格,請使用 Format-Custom。
範例 1
C:\PS>get-service | format-list
描述
-----------
這個命令將電腦中的服務相關資訊格式化為清單。根據預設,會將服務格式化為表格。Get-Service Cmdlet 會取得在電腦中代表服務的物件。管線運算子 (|) 透過管線將結果傳遞給 Format-List。接著,Format-List 命令會將服務資訊格式化為清單,再將它傳送到預設輸出 Cmdlet 以供顯示。
範例 2
C:\PS>$a = get-childitem $pshome\*.ps1xml
描述
-----------
這些命令將 Windows PowerShell 目錄中 PS1XML 檔案的相關資訊顯示為清單。第一個命令取得代表檔案的物件,再將它們儲存在 $a 變數中。第二個命令則使用 Format-List 將 $a 中所儲存之有關物件的資訊格式化。這個命令會使用 InputObject 參數將此變數傳遞給 Format-List,然後後者會將格式化的輸出傳送到預設輸出 Cmdlet 以供顯示。
範例 3
C:\PS>get-process | format-list -property name, basepriority, priorityclass
描述
-----------
這個命令顯示電腦中每個處理序的名稱、基本優先順序和優先類別。它會使用 Get-Process Cmdlet 來取得代表每個處理序的物件。管線運算子 (|) 透過管線將處理序物件傳遞給 Format-List。Format-List 會將處理序格式化為指定的屬性清單。"Property" 參數名稱為選擇項,因此可以省略。
範例 4
C:\PS>get-process winlogon | format-list -property *
描述
-----------
這個命令顯示 Winlogon 處理序的所有屬性。它會使用 Get-Process Cmdlet 來取得代表 Winlogon 處理序的物件。管線運算子 (|) 會透過管線將 Winlogon 處理序物件傳遞給 Format-List。命令使用 Property 參數來指定屬性,並以 * 表示所有屬性。因為 Property 參數的名稱為選擇性,您可以加以省略,而將命令輸入為:"format-list *"。Format-List 會自動將結果傳送到預設輸出 Cmdlet 以供顯示。