ConvertTo-Xml

  • 參考
模組:
Microsoft.PowerShell.Utility

建立物件的 XML 型表示法。

Syntax

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

Description

Cmdlet ConvertTo-Xml 會建立一 或多個 .NET 物件的 XML 型 表示法。 若要使用此 Cmdlet，請使用管線將一或多個對象傳送至 Cmdlet，或使用 InputObject 參數來指定物件。

當您使用管線將多個物件傳送至ConvertTo-Xml或使用 InputObject 參數提交多個物件時，ConvertTo-Xml會傳回包含所有物件表示法的單一記憶體內部 XML 檔。

此 Cmdlet 類似於 Export-Clixml，但會將產生的 XML 儲存在 Common Language Infrastructure （CLI） 檔案中，而該檔案可以使用 Import-Clixml 重新匯入為物件。Export-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。

Type:String
Accepted values:Stream, String, Document
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

指定 XML 表示法中包含多少個自主物件的層級。 預設值是 1。

例如，如果對象的屬性也包含 物件，若要儲存所包含對象的屬性的 XML 表示法，您必須指定深度 2。

您可以在 Types.ps1xml 檔案中覆寫物件類型的預設值。 如需詳細資訊，請參閱 about_Types.ps1xml。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

指定要轉換的物件。 輸入包含 物件的變數，或輸入取得物件的命令或表達式。 您也可以使用管線將 物件傳送至 ConvertTo-XML。

Type:PSObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoTypeInformation

省略對象節點的 Type 屬性。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

PSObject

您可以使用管線將任何物件傳送至此 Cmdlet

輸出

String

當您使用 As 參數並將值設定為 string時，這個 Cmdlet 會將 XML 當做字串傳回。 當值為 stream時，這個 Cmdlet 會傳回字串數位。

XmlDocument

根據預設，此 Cmdlet 會傳回 XML 檔。