ConvertTo-Xml
建立物件的 XML 型表示法。
語法
Default (預設值)
ConvertTo-Xml
[-InputObject] <PSObject>
[-Depth <Int32>]
[-NoTypeInformation]
[-As <String>]
[<CommonParameters>]
Description
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