Share via

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 ，不同之處在於會將 Export-Clixml 產生的 XML 儲存在 Common Language Infrastructure (CLI) XML 檔案中，這些檔案可以使用 Import-Clixml 重新匯入為物件。 ConvertTo-Xml 會傳回 XML 檔的記憶體內部表示法，因此您可以繼續在 PowerShell 中處理它。 ConvertTo-Xml 沒有將物件轉換成 CLI XML 的選項。

範例

範例 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。

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

您可以使用管線將任何物件傳送至 ConvertTo-XML。

輸出

System.String or System.Xml.XmlDocument

As 參數的值會決定 ConvertTo-XML 傳回的物件類型。