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

语法

Update-FormatData [[-AppendPath] <string[]>] [-PrependPath <string[]>] [-Confirm] [-WhatIf] [<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。

参数

-AppendPath <string[]>

将指定的格式设置文件添加到会话中。这些文件在 Windows PowerShell 加载内置格式设置文件之后加载。

在对 .NET 对象进行格式设置时，Windows PowerShell 将为每个 .NET 类型使用它所找到的第一个格式设置定义。如果使用 AppendPath 参数，则 Windows PowerShell 将从内置文件搜索数据，直到遇到要添加的格式数据。

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

是否为必需？

false

位置？

1

默认值

是否接受管道输入？

true (ByValue, ByPropertyName)

是否接受通配符？

false

-PrependPath <string[]>

将指定的格式设置文件添加到会话中。这些文件在 Windows PowerShell 加载内置格式设置文件之前加载。

在对 .NET 对象进行格式设置时，Windows PowerShell 将为每个 .NET 类型使用它所找到的第一个格式设置定义。如果使用 PrependPath 参数，则 Windows PowerShell 将从要添加的文件中搜索数据，直到遇到内置文件中的格式数据。

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

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-Confirm

在执行命令之前提示您进行确认。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-WhatIf

描述如果执行该命令会发生什么情况（无需实际执行该命令）。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

<CommonParameters>

此 cmdlet 支持通用参数：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息，请参阅 about_Commonparameters.

输入和输出

输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。

输入

System.String

可以通过管道将包含追加路径的字符串传递给 Update-FormatData。

输出

None

该 cmdlet 不返回任何输出。

说明

Update-FormatData 也会在从模块导入的会话中更新命令的格式数据。如果模块的格式设置文件发生更改，可以运行 Update-FormatData 命令以更新已导入命令的格式数据。无需重新导入模块。

示例 1

C:\PS>update-formatdata

说明
-----------
此命令重新加载它以前加载的格式设置文件。

示例 2

C:\PS>update-formatdata -appendpath trace.format.ps1xml, log.format.ps1xml

说明
-----------
此命令将格式设置文件重新加载到会话，其中包括两个新文件 Trace.format.ps1xml 和 Log.format.ps1xml。

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

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

示例 3

C:\PS>update-formatdata -prependPath c:\test\NewFiles.format.ps1xml

# Edit the NewFiles.format.ps1 file.

C:\PS> update-formatdata

说明
-----------
此示例说明如何在编辑格式设置文件后重新加载该文件。

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

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

第二条命令使用 Update-FormatData cmdlet 重新加载格式设置文件。由于 NewFiles.format.ps1xml 文件以前加载过，因此在不使用参数的情况下 Update-FormatData 会自动重新加载它。



目录