ConvertTo-Xml

建立基於 XML 的物件表示法。

語法

Default (預設值)

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

Description

ConvertTo-Xml 指令檔會建立一個或多個.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 物件。

預設值為 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

你可以把任何物件都導到這個指令檔

輸出

String

當你使用 As 參數並將值設為 string時,這個 cmdlet 會以字串的形式回傳 XML。 當值為 stream時,此 cmdlet 會回傳一個字串陣列。

XmlDocument

預設情況下,此指令小程式會回傳一個 XML 文件。