ConvertTo-Xml
创建对象的基于 XML 的表示形式。
语法
Default (默认值)
ConvertTo-Xml
[-InputObject] <PSObject>
[-Depth <Int32>]
[-NoTypeInformation]
[-As <String>]
[<CommonParameters>]
说明
ConvertTo-Xml cmdlet 创建一个或多个Microsoft .NET Framework 对象的基于 XML 的表示形式。
若要使用此 cmdlet,请通过管道将一个或多个对象传递给 cmdlet,或使用 InputObject 参数指定对象。
当通过管道将多个对象传递给 ConvertTo-Xml 或使用 InputObject 参数提交多个对象时,ConvertTo-Xml 返回包含所有对象的表示形式的单个 XML 文档。
此 cmdlet 类似于 Export-Clixml,不同之处在于 Export-Clixml 将生成的 XML 存储在文件中。
ConvertTo-Xml 返回 XML,因此你可以继续在 PowerShell 中处理它。
示例
示例 1:将日期转换为 XML
PS C:\> Get-Date | ConvertTo-Xml
此命令将当前日期(DateTime 对象)转换为 XML。
示例 2:将进程转换为 XML
PS C:\> ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3
此命令将表示计算机上的所有进程的进程对象转换为 XML 文档。 对象扩展到三个级别的深度。
参数
-As
确定输出格式。 此参数的可接受值为:
- 字符串。 返回单个字符串。
- 流。 返回字符串数组。
- 文档。 返回 XmlDocument 对象。
默认值为 Document。
参数属性
| 类型: | String |
| 默认值: | None |
| 接受的值: | Stream, String, Document |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Depth
指定 XML 表示形式中包含多少个包含对象的级别。 默认值为 1。
例如,如果对象的属性还包含对象,若要保存包含对象的属性的 XML 表示形式,则必须指定深度为 2。
可以为 Types.ps1xml 文件中的对象类型重写默认值。 有关详细信息,请参阅 about_Types.ps1xml。
参数属性
| 类型: | Int32 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-InputObject
指定要转换的对象。 输入包含对象的变量,或键入获取对象的命令或表达式。 还可以通过管道将对象传递给 ConvertTo-XML。
参数属性
| 类型: | PSObject |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-NoTypeInformation
省略对象节点中的 Type 属性。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输入
PSObject
可以通过管道将任何对象传递给 ConvertTo-XML。
输出
System.String or System.Xml.XmlDocument
As 参数的值确定 ConvertTo-XML 返回的对象的类型。