Update-FormatData

参考

模块:: Microsoft.PowerShell.Utility

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

语法

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

说明

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 命令来更新导入的命令的格式设置数据。无需再次导入模块。

通过