Export-FormatData

参考

模块:: Microsoft.PowerShell.Utility

在格式化文件中保存当前会话中的格式设置数据。

语法

Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -Path <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]

Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -LiteralPath <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]

说明

Export-FormatData cmdlet 从当前会话中的格式化对象创建 PowerShell 格式化文件（format.ps1xml）。它采用 ExtendedTypeDefinition 对象，这些对象 Get-FormatData 返回并将它们以 XML 格式保存。

PowerShell 使用格式化文件（format.ps1xml）中的数据生成会话中Microsoft .NET Framework 对象的默认显示。可以查看和编辑格式化文件，并使用 Update-FormatData cmdlet 将格式数据添加到会话。

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

示例

示例 1：导出会话格式数据

Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock

此命令将会话中的所有格式数据导出到 AllFormat.ps1xml 文件。

该命令使用 Get-FormatData cmdlet 获取会话中的格式数据。 TypeName 参数的 * （all）值指示 cmdlet 获取会话中的所有数据。

该命令使用管道运算符（|）将格式数据从 Get-FormatData 命令发送到 Export-FormatData cmdlet，该 cmdlet 会将格式数据导出到 AllFormat.ps1 文件。

Export-FormatData 命令使用 IncludeScriptBlock 参数将脚本块包含在文件中的格式数据中。

示例 2：导出类型的格式数据

$F = Get-FormatData -TypeName "helpinfoshort"
Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlock

这些命令将 HelpInfoShort 类型的格式数据导出到 Help.format.ps1xml 文件。

第一个命令使用 Get-FormatData cmdlet 获取 HelpInfoShort 类型的格式数据，并将其保存在 $F 变量中。

第二个命令使用 Export-FormatData cmdlet 的 InputObject 参数输入 $F 变量中保存的格式数据。它还使用 IncludeScriptBlock 参数在输出中包含脚本块。

示例 3：导出不带脚本块的格式数据

Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path process.format.ps1xml
Update-FormatData -PrependPath ".\process.format.ps1xml"
Get-Process p*

Handles  NPM(K)  PM(K)  WS(K) VM(M)   CPU(s)    Id ProcessName
-------  ------  -----  ----- -----   ------    -- -----------
323                                       5600 powershell
336                                       3900 powershell_ise
138                                       4076 PresentationFontCache

此示例显示从 Export-FormatData 命令中省略 IncludeScriptBlock 参数的效果。

第一个命令使用 Get-FormatData cmdlet 获取 Get-Process cmdlet 返回的 System.Diagnostics.Process 对象的格式数据。该命令使用管道运算符（|）将格式数据发送到 Export-FormatData cmdlet，后者将其导出到当前目录中的 Process.format.ps1xml 文件。

在这种情况下，Export-FormatData 命令不使用 IncludeScriptBlock 参数。

第二个命令使用 Update-FormatData cmdlet 将 Process.format.ps1xml 文件添加到当前会话。该命令使用 PrependPath 参数来确保在处理对象的标准格式数据之前找到 Process.format.ps1xml 文件中处理对象的格式数据。

第三个命令显示此更改的效果。该命令使用 Get-Process cmdlet 获取名称以 P 开头的进程。输出显示显示中缺少使用脚本块计算的属性值。

参数

-Force

强制命令运行而不要求用户确认。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IncludeScriptBlock

指示是否导出格式数据的脚本块。

由于脚本块包含代码并且可以恶意使用，因此默认情况下不会导出这些代码。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-InputObject

指定要导出的格式数据对象。输入一个变量，其中包含对象或获取对象的命令，例如 Get-FormatData 命令。还可以通过管道将对象从 Get-FormatData 传递给 Export-FormatData。

类型:	ExtendedTypeDefinition[]
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-LiteralPath

指定输出文件的位置。与 Path 参数不同，LiteralPath 的值与键入时完全相同。不会将任何字符解释为通配符。如果路径包含转义字符，请将它括在单引号中。单引号告知 PowerShell 不要将任何字符解释为转义序列。

类型:	String
别名:	PSPath, LP
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-NoClobber

指示 cmdlet 不会覆盖现有文件。默认情况下，Export-FormatData 覆盖文件而不发出警告，除非该文件具有只读属性。

若要指示 Export-FormatData 覆盖只读文件，请使用 Force 参数。

类型:	SwitchParameter
别名:	NoOverwrite
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Path

指定输出文件的位置。输入路径（可选）和文件扩展名为 format.ps1xml 的文件名。如果省略路径，Export-FormatData 在当前目录中创建该文件。

如果使用 .ps1xml 以外的文件扩展名，Update-FormatData cmdlet 将无法识别该文件。

如果指定现有文件，则 Export-FormatData 覆盖文件而不发出警告，除非该文件具有只读属性。若要覆盖只读文件，请使用 Force 参数。若要防止覆盖文件，请使用 NoClobber 参数。

类型:	String
别名:	FilePath
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

输入

ExtendedTypeDefinition

可以通过管道将 ExtendedTypeDefinition 对象从 Get-FormatData 传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。它会生成一个文件，并将其保存在指定的路径中。

备注

若要使用任何格式设置文件（包括导出的格式文件），会话的执行策略必须允许脚本和配置文件运行。有关详细信息，请参阅 about_Execution_Policies。

通过