ConvertTo-Xml
Vytvoří reprezentaci objektu založenou na jazyce XML.
Syntax
Default (Výchozí)
ConvertTo-Xml
[-InputObject] <PSObject>
[-Depth <Int32>]
[-NoTypeInformation]
[-As <String>]
[<CommonParameters>]
Description
Rutina ConvertTo-Xml vytvoří reprezentaci založené na jazyce XML jednoho nebo více objektů rozhraní Microsoft .NET Framework.
Chcete-li použít tuto rutinu, předaný jeden nebo více objektů do rutiny nebo použijte InputObject parametr k určení objektu.
Když předáte více objektů do ConvertTo-Xml nebo použijete parametr InputObject k odeslání více objektů, ConvertTo-Xml vrátí jeden dokument XML, který obsahuje reprezentaci všech objektů.
Tato rutina se podobá Export-Clixml s tím rozdílem, že Export-Clixml uloží výsledný kód XML do souboru.
ConvertTo-Xml vrátí xml, takže ho můžete dál zpracovávat v PowerShellu.
Příklady
Příklad 1: Převod data na XML
PS C:\> Get-Date | ConvertTo-Xml
Tento příkaz převede aktuální datum (objekt DateTime) na XML.
Příklad 2: Převod procesů na XML
PS C:\> ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3
Tento příkaz převede procesní objekty, které představují všechny procesy v počítači do dokumentu XML. Objekty jsou rozbalené na hloubku tří úrovní.
Parametry
-As
Určuje výstupní formát. Přijatelné hodnoty pro tento parametr jsou:
- Řetězec. Vrátí jeden řetězec.
- Proud. Vrátí pole řetězců.
- Dokument. Vrátí objekt XmlDocument.
Výchozí hodnota je Document.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Přípustné hodnoty: | Stream, String, Document |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Depth
Určuje, kolik úrovní obsažených objektů je součástí reprezentace XML. Výchozí hodnota je 1.
Pokud například vlastnosti objektu také obsahují objekty, chcete-li uložit reprezentaci XML vlastností obsažených objektů, je nutné zadat hloubku 2.
Výchozí hodnotu lze přepsat pro typ objektu v souborech Types.ps1xml. Další informace najdete v tématu about_Types.ps1xml.
Vlastnosti parametru
| Typ: | Int32 |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-InputObject
Určuje objekt, který se má převést. Zadejte proměnnou, která obsahuje objekty, nebo zadejte příkaz nebo výraz, který objekty získá. Objekty lze také pipetovat do ConvertTo-XML.
Vlastnosti parametru
| Typ: | PSObject |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | True |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-NoTypeInformation
Vynechá atribut Type z uzlů objektů.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
Vstupy
PSObject
Libovolný objekt můžete převést na ConvertTo-XML.
Výstupy
System.String or System.Xml.XmlDocument
Hodnota parametru As určuje typ objektu, který ConvertTo-XML vrátí.