共用方式為

Update-FormatData

  • 參考
模組:
Microsoft.PowerShell.Utility

更新目前會話中的格式化數據。

語法

Update-FormatData
      [[-AppendPath] <String[]>]
      [-PrependPath <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update-FormatData Cmdlet 會將格式化數據從格式化檔案重載到目前的會話。 此 Cmdlet 可讓您更新格式化數據，而不需重新啟動 Windows PowerShell。

如果沒有參數，Update-FormatData 會重載先前載入的格式化檔案。 您可以使用 update-FormatData 的參數，將新的格式化檔案新增至會話。

格式化檔案是 XML 格式的文字檔，擴展名為 format.ps1xml。 檔案中的格式化數據會定義會話中Microsoft .NET Framework 對象的顯示。

當 Windows PowerShell 啟動時，它會將格式數據從 Windows PowerShell 安裝目錄中的格式檔案 （$pshome） 載入工作階段。 您可以使用 Update-FormatData，在不重新啟動 Windows PowerShell 的情況下，將格式化數據重載至目前的會話。 當您新增或變更格式化檔案，但不想中斷會話時，這會很有用。

如需在 Windows PowerShell 中格式化檔案的詳細資訊，請參閱 about_Format.ps1xml。

範例

範例 1：重載先前載入的格式設定檔案

PS C:\> Update-FormatData

此命令會重載先前載入的格式化檔案。

範例 2：重載格式化檔案和追蹤和記錄格式檔案

PS C:\> Update-FormatData -AppendPath "trace.format.ps1xml, log.format.ps1xml"

此命令會將格式化檔案重載至會話，包括兩個新檔案 Trace.format.ps1xml 和 Log.format.ps1xml。

因為命令使用 AppendPath 參數，因此新檔案中的格式化數據會在內建檔案的格式數據之後載入。

會使用 AppendPath 參數，因為新檔案包含內建檔案中未參考之物件的格式化數據。

範例 3：編輯格式化檔案並重載

PS C:\> Update-FormatData -PrependPath "c:\test\NewFiles.format.ps1xml"

# Edit the NewFiles.format.ps1 file.

PS C:\> Update-FormatData

此範例示範如何在編輯格式化檔案之後重載格式檔案。

第一個命令會將 NewFiles.format.ps1xml 檔案新增至會話。 它使用 PrependPath 參數，因為檔案包含內建檔案中所參考物件的格式化數據。

新增 NewFiles.format.ps1xml 檔案並在這些會話中進行測試之後，作者會編輯檔案。

第二個命令會使用 Update-FormatData Cmdlet 來重載格式化檔案。 因為先前已載入 NewFiles.format.ps1xml 檔案，所以 Update-FormatData 會自動重載它而不使用參數。

參數

-AppendPath

指定此 Cmdlet 新增至工作階段的格式檔案。 這些檔案會在 Windows PowerShell 載入內建格式檔案之後載入。

格式化 .NET 物件時，Windows PowerShell 會使用針對每個 .NET 類型找到的第一個格式定義。 如果您使用 AppendPath 參數，Windows PowerShell 會在遇到您要新增的格式數據之前，先從內建檔案搜尋數據。

使用此參數來新增格式化內建格式檔案中未參考之 .NET 對象的檔案。

類型:String[]
別名:PSPath, Path
Position:0
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

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

-PrependPath

指定此 Cmdlet 新增至工作階段的格式檔案。 檔案會在 Windows PowerShell 載入內建格式檔案之前載入。

格式化 .NET 物件時，Windows PowerShell 會使用針對每個 .NET 類型找到的第一個格式定義。 如果您使用 PrependPath 參數，Windows PowerShell 會在遇到內建檔案的格式設定數據之前，先從您新增的檔案搜尋數據。

使用此參數新增檔案，以格式化內建格式檔案中也參考的 .NET 物件。

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

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

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

輸入

String

您可以使用管線將包含附加路徑的字串傳送至 Update-FormatData。

輸出

None

Cmdlet 不會傳回任何輸出。

備註

  • Update-FormatData 也會更新從模組匯入之會話中命令的格式數據。 如果模組的格式檔變更，您可以執行 Update-FormatData 命令來更新匯入命令的格式數據。 您不需要再次匯入模組。