更新格式数据 (Microsoft.PowerShell.Utility)

Update-FormatData

更新当前会话中的格式化数据。

句法

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

描述

Update-FormatData cmdlet 将格式化文件中的格式化数据重新加载到当前会话中。此 cmdlet 允许您更新格式化数据，而无需重新启动 PowerShell。

如果没有参数，Update-FormatData 会重新加载之前加载的格式化文件。您可以使用 Update-FormatData 的参数将新的格式化文件添加到会话中。

格式化文件是 XML 格式的文本文件，文件扩展名为 format.ps1xml。文件中的格式数据定义 Microsoft .NET Framework 对象在会话中的显示。

当 PowerShell 启动时，它会从 PowerShell 源代码加载格式数据。但是，您可以创建自定义 format.ps1xml 文件来更新当前会话中的格式。您可以使用 Update-FormatData 将格式化数据重新加载到当前会话中，而无需重新启动 PowerShell。当您添加或更改格式化文件但又不想中断会话时，这非常有用。

有关在 PowerShell 中格式化文件的详细信息，请参阅 about_Format.ps1xml。

示例

示例 1：重新加载先前加载的格式化文件

Update-FormatData

此命令重新加载之前加载的格式化文件。

示例 2：重新加载格式化文件以及跟踪和日志格式化文件

Update-FormatData -AppendPath "trace.format.ps1xml, log.format.ps1xml"

此命令将格式化文件重新加载到会话中，包括两个新文件：Trace.format.ps1xml 和 Log.format.ps1xml。

由于该命令使用 AppendPath 参数，因此新文件中的格式化数据会在内置文件中的格式化数据之后加载。

使用AppendPath 参数是因为新文件包含内置文件中未引用的对象的格式数据。

示例 3：编辑格式化文件并重新加载

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

# Edit the NewFiles.format.ps1 file.

Update-FormatData

此示例演示如何在编辑格式化文件后重新加载该文件。

第一个命令将 NewFiles.format.ps1xml 文件添加到会话中。它使用 PrependPath 参数，因为该文件包含内置文件中引用的对象的格式数据。

添加 NewFiles.format.ps1xml 文件并在这些会话中对其进行测试后，作者编辑了该文件。

第二个命令使用 Update-FormatData cmdlet 重新加载格式化文件。由于先前已加载 NewFiles.format.ps1xml 文件，Update-FormatData 会自动重新加载该文件，而无需使用参数。

参数

-AppendPath

指定此 cmdlet 添加到会话的格式化文件。这些文件是在 PowerShell 加载内置格式文件后加载的。

格式化 .NET 对象时，PowerShell 使用它为每个 .NET 类型找到的第一个格式化定义。如果您使用 AppendPath 参数，PowerShell 会在遇到您要添加的格式数据之前从内置文件中搜索数据。

使用此参数添加一个文件，用于格式化内置格式化文件中未引用的 .NET 对象。

String[]

PSPath, Path

0

None

False

True

False

-Confirm

在运行 cmdlet 之前提示您进行确认。

SwitchParameter

cf

命名

False

False

False

False

-PrependPath

指定此 cmdlet 添加到会话的格式化文件。这些文件在 PowerShell 加载内置格式文件之前加载。

格式化 .NET 对象时，PowerShell 使用它为每个 .NET 类型找到的第一个格式化定义。如果您使用 PrependPath 参数，PowerShell 会在遇到内置文件中的格式数据之前搜索您要添加的文件中的数据。

使用此参数添加一个用于格式化 .NET 对象的文件，该对象也在内置格式化文件中引用。

String[]

命名

None

False

False

False

-WhatIf

显示 cmdlet 运行时会发生什么情况。该 cmdlet 未运行。

SwitchParameter

wi

命名

False

False

False

False

输入

字符串

您可以通过管道传输包含此 cmdlet 的附加路径的字符串。

输出

无

此 cmdlet 不返回任何输出。

笔记

• Update-FormatData 还会更新会话中从模块导入的命令的格式数据。如果模块的格式化文件发生更改，您可以运行 Update-FormatData 命令来更新导入命令的格式化数据。您不需要再次导入该模块。