ConvertTo-XML
建立物件的 XML 表示。
語法
ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTypeInformation] [<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，因此您可以在 Windows PowerShell 中繼續處理它。
參數
-As <string>
決定輸出格式。有效的值包括：
-- String： 傳回單一字串。
-- Stream： 傳回字串的陣列。
-- Document： 傳回 XmlDocument 物件。
預設為 Stream。
必要? |
false |
位置? |
named |
預設值 |
串流 |
接受管線輸入? |
false |
接受萬用字元? |
false |
-Depth <int>
指定 XML 表示中所含之物件的層級數量。預設值為 1。
例如，若物件的屬性也包含物件，要將這些內含物件的屬性儲存成 XML 表示，就必須將深度指定為 2。
您可以在 Types.ps1xml 檔案中覆寫物件型別的預設值。如需詳細資訊，請參閱 about_Types.ps1xml。
必要? |
false |
位置? |
named |
預設值 |
1 |
接受管線輸入? |
false |
接受萬用字元? |
false |
-InputObject <psobject>
指定要轉換的物件。請輸入包含物件的變數，或輸入可取得物件的命令或運算式。您也可經由管道將物件輸出至 ConvertTo-XML。
必要? |
true |
位置? |
1 |
預設值 |
無 |
接受管線輸入? |
true (ByValue) |
接受萬用字元? |
true |
-NoTypeInformation
省略 object 節點的 Type 屬性。
必要? |
false |
位置? |
named |
預設值 |
False |
接受管線輸入? |
false |
接受萬用字元? |
false |
<CommonParameters>
這個 Cmdlet 支援一般參數：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊，請參閱 about_Commonparameters.
輸入和輸出
輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。
輸入 |
System.Management.Automation.PSObject 您可經由管道將任何物件輸出至 ConvertTo-XML。 |
輸出 |
System.String 或 System.Xml.XmlDocument As 參數的值會決定 ConvertTo-XML 傳回的物件類型。 |
範例 1
C:\PS>get-date | convertto-xml
描述
-----------
這個命令會將目前的日期 (DateTime 物件) 轉換成 XML。
範例 2
C:\PS>convertto-xml -as Document -inputObject (get-process) -depth 3
描述
-----------
這個命令會將那些代表電腦上所有處理序的處理序物件轉換成 XML 文件，並將物件展開成 3 層。