ConvertTo-Xml (Microsoft.PowerShell.Utility)

ConvertTo-Xml

创建对象的基于 XML 的表示形式。

句法

ConvertTo-Xml
              [-Depth <Int32>]
              [-InputObject] <PSObject>
              [-NoTypeInformation]
              [-As <String>]
              [<CommonParameters>]

描述

ConvertTo-Xml cmdlet 创建一个或多个 .NET 对象的基于 XML 的表示形式。要使用此 cmdlet，请将一个或多个对象通过管道传递给该 cmdlet，或使用 InputObject 参数指定该对象。

当您通过管道将多个对象传送到 ConvertTo-Xml 或使用 InputObject 参数提交多个对象时，ConvertTo-Xml 返回一个内存中的对象包含所有对象表示的 XML 文档。

此 cmdlet 与 Export-Clixml 类似，不同之处在于 Export-Clixml 将生成的 XML 存储在公共语言基础结构 (CLI) 文件中，该文件可以使用 Import-Clixml 作为对象重新导入。 ConvertTo-Xml 返回 XML 文档的内存中表示形式，以便您可以继续在 PowerShell 中处理它。 ConvertTo-Xml 没有将对象转换为 CLI XML 的选项。

示例

示例 1：将日期转换为 XML

Get-Date | ConvertTo-Xml

此命令将当前日期（DateTime 对象）转换为 XML。

示例 2：将流程转换为 XML

ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3

此命令将表示计算机上所有进程的进程对象转换为 XML 文档。对象扩展到三个级别的深度。

参数

-As

确定输出格式。该参数可接受的值为：

• String - 返回单个字符串。
• Stream - 返回字符串数组。
• Document - 返回一个 XmlDocument 对象。

默认值为文档。

String

流、字符串、文档

命名

None

False

False

False

-Depth

指定 XML 表示形式中包含的包含对象的级别。默认值为 1。

例如，如果对象的属性还包含对象，则要保存所包含对象的属性的 XML 表示形式，必须指定深度为 2。

可以覆盖 Types.ps1xml 文件中对象类型的默认值。有关详细信息，请参阅 about_Types.ps1xml。

整数32

命名

None

False

False

False

-InputObject

指定要转换的对象。输入包含对象的变量，或键入获取对象的命令或表达式。您还可以通过管道将对象传送到 ConvertTo-XML。

PS对象

0

None

True

True

False

-NoTypeInformation

省略对象节点的 Type 属性。

SwitchParameter

命名

None

False

False

False

输入

PSObject

您可以通过管道将任何对象传递给此 cmdlet

输出

字符串

当您使用 As 参数并将值设置为 string 时，此 cmdlet 将 XML 作为字符串返回。当值为 stream 时，此 cmdlet 返回字符串数组。

Xml文档

默认情况下，此 cmdlet 返回 XML 文档。