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

语法

ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTypeInformation] [<CommonParameters>]

说明

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

当通过管道将多个对象传递至 ConvertTo-XML 或使用 InputObject 参数来提交多个对象时，ConvertTo-XML 会返回单个 XML 文档，该文档包括所有对象的表示形式。

除了 Export-Clixml 将所得到的 XML 存储在文件中以外，此 cmdlet 与 Export-Clixml 相似。ConvertTo-XML 会返回 XML，因此可在 Windows PowerShell 中继续处理它。

参数

-As <string>

确定输出格式。有效值包括：

-- String：返回单个字符串。

-- Stream：返回一个字符串数组。

-- Document：返回一个 XmlDocument 对象。

默认值为 Stream。

是否为必需？

false

位置？

named

默认值

Stream

是否接受管道输入？

false

是否接受通配符？

false

-Depth <int>

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

例如，如果对象属性也包含对象，那么要对被包含对象的属性的 XML 表示形式进行保存，则必须将级别深度指定为 2。

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

是否为必需？

false

位置？

named

默认值

1

是否接受管道输入？

false

是否接受通配符？

false

-InputObject <psobject>

指定要转换的对象。输入一个包含对象的变量，或键入可获取对象的命令或表达式。也可将对象通过管道传递至 ConvertTo-XML。

是否为必需？

true

位置？

1

默认值

无

是否接受管道输入？

true (ByValue)

是否接受通配符？

true

-NoTypeInformation

省略对象节点的 Type 属性。

是否为必需？

false

位置？

named

默认值

False

是否接受管道输入？

false

是否接受通配符？

false

<CommonParameters>

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

输入和输出

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

输入

System.Management.Automation.PSObject

可以通过管道将任何对象传递给 ConvertTo-XML。

输出

System.String 或 System.Xml.XmlDocument

As 参数的值确定由 ConvertTo-XML 返回的对象类型。

示例 1

C:\PS>get-date | convertto-xml

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

示例 2

C:\PS>convertto-xml -as Document -inputObject (get-process) -depth 3

说明
-----------
此命令将表示计算机上所有进程的进程对象转换为一个 XML 文档。这些对象的深度将扩展至三层。

另请参阅



目录