Format-Custom

  • 參考
模組:
Microsoft.PowerShell.Utility

使用自定義檢視來格式化輸出。

Syntax

Format-Custom
      [[-Property] <Object[]>]
      [-Depth <Int32>]
      [-GroupBy <Object>]
      [-View <String>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <String>]
      [-InputObject <PSObject>]
      [<CommonParameters>]

Description

Cmdlet 會將 Format-Custom 命令的輸出格式化為替代檢視中所定義。 Format-Custom 是設計來顯示不只是數據表或只是清單的檢視。 您可以使用PowerShell中定義的檢視，或在新的 format.ps1xml 檔案中建立自己的檢視，並使用 Update-FormatData Cmdlet 將它們新增至 PowerShell。

範例

範例 1：使用自定義檢視格式化輸出

Get-Command Start-Transcript | Format-Custom -View MyView

此命令會格式化 MyView 檢視所定義之格式的 Cmdlet 資訊 Start-Transcript ，這是使用者所建立的自定義檢視。 若要成功執行此命令，您必須先建立新的 PS1XML 檔案、定義 MyView 檢視，然後使用 Update-FormatData 命令將 PS1XML 檔案新增至 PowerShell。

範例 2：使用預設檢視格式化輸出

Get-Process Winlogon | Format-Custom

此命令會將 Winlogon 程式的相關信息格式化為替代自定義檢視。 因為命令不使用 View 參數， Format-Custom 因此會使用預設的自定義檢視來格式化數據。

範例 3：疑難解答格式錯誤

下列範例顯示使用表示式新增 DisplayError 或 ShowError 參數的結果。

PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  = #ERR
}


PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  =
}

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:01:04 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

參數

-Depth

指定顯示中的數據行數目。

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

-DisplayError

在命令行上顯示錯誤。 這個參數很少使用，但是當您在命令中 Format-Custom 格式化表達式時，可用來做為偵錯輔助，而且表達式似乎無法運作。

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

-Expand

格式化集合物件，以及集合中的物件。 此參數的設計目的是要格式化支援 System.Collections.ICollection 介面的物件。 預設值為 EnumOnly。

有效值為：

  • EnumOnly：顯示集合中對象的屬性。
  • CoreOnly：顯示集合對象的屬性。
  • 兩者：顯示集合物件的屬性和集合中的物件。
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

指示 Cmdlet 顯示所有錯誤資訊。 搭配 DisplayError 或 ShowError 參數使用。 根據預設，當錯誤物件寫入錯誤或顯示數據流時，只會顯示部分錯誤資訊。

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

-GroupBy

根據共用屬性或值，將輸出格式化為群組。 輸入輸出的表達式或屬性。

GroupBy 參數的值可以是新的導出屬性。 匯出屬性可以是腳本區塊或哈希表。 有效的機碼/值組如下：

  • 名稱 （或標籤） - <string>
  • 表達式 - <string> 或 <script block>
  • FormatString - <string>

如需詳細資訊，請參閱 about_Calculated_Properties。

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

-InputObject

指定要格式化的物件。 輸入包含 物件的變數，或輸入取得物件的命令或表達式。

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

-Property

指定顯示在顯示中的物件屬性，以及它們出現的順序。 允許通配符。

如果您省略此參數，顯示中顯示的屬性取決於所顯示的物件。 參數名稱 屬性 是選擇性的。 您無法在同一個命令中使用 Property 和 View 參數。

Property 參數的值可以是新的導出屬性。 匯出屬性可以是腳本區塊或哈希表。 有效的機碼/值組如下：

  • 表達式 - <string> 或 <script block>
  • 深度- <int32>

如需詳細資訊，請參閱 about_Calculated_Properties。

Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

透過管線傳送錯誤。 這個參數很少使用，但是當您在命令中 Format-Custom 格式化表達式時，可用來做為偵錯輔助，而且表達式似乎無法運作。

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

-View

指定替代格式或檢視的名稱。 如果您省略此參數， Format-Custom 請使用預設自定義檢視。 您無法在同一個命令中使用 Property 和 View 參數。

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

輸入

PSObject

您可以使用管線將任何物件傳送至此 Cmdlet。

輸出

Microsoft.PowerShell.Commands.Internal.Format

此 Cmdlet 會傳回代表顯示的格式物件。

備註

PowerShell 包含下列的 Format-Custom別名：

  • 所有平臺：
    • fc

Format-Custom 是設計來顯示不只是數據表或只是清單的檢視。 若要顯示替代資料表檢視，請使用 Format-Table。 若要顯示替代清單檢視，請使用 Format-List。

GroupBy 參數會假設物件已排序。 使用 Format-Custom 來群組物件之前，請使用 Sort-Object 來排序物件。