ConvertTo-Xml

  • Reference
Modul:
Microsoft.PowerShell.Utility

Vytvoří reprezentaci objektu založenou na jazyce XML.

Syntax

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

Description

Rutina ConvertTo-Xml vytvoří reprezentaci objektu .NET založenou na jazyce XML. Chcete-li použít tuto rutinu, předaný jeden nebo více objektů do rutiny, nebo pomocí parametru InputObject určete objekt.

Když předáte více objektů nebo ConvertTo-Xml použijete InputObject k odeslání více objektů, ConvertTo-Xml vrátí jeden dokument XML v paměti, který obsahuje reprezentace všech objektů.

Tato rutina se podobá exportu clixml s tím rozdílem, že Export-Clixml uloží výsledný kód XML do souboru CLR (Common Language Infrastructure), který je možné znovu importovat jako objekty pomocí Import-Clixml. ConvertTo-Xml vrátí reprezentaci dokumentu XML v paměti, abyste ho mohli dál zpracovávat v PowerShellu. ConvertTo-Xml nemá možnost převést objekty na XML rozhraní příkazového řádku.

Příklady

Příklad 1: Převod data na XML

Get-Date | ConvertTo-Xml

Tento příkaz převede aktuální datum ( objekt DateTime ) na XML.

Příklad 2: Převod procesů na XML

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. Tento parametr přijímá tyto hodnoty:

  • String – Vrátí jeden řetězec.
  • Stream – Vrátí pole řetězců.
  • Document - Vrátí objekt XmlDocument .

Výchozí hodnota je Document.

Type:String
Accepted values:Stream, String, Document
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-NoTypeInformation

Vynechá atribut Type z uzlů objektů.

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

Vstupy

PSObject

Do této rutiny můžete převést libovolný objekt.

Výstupy

String

Pokud použijete parametr As a nastavíte hodnotu na string, vrátí tato rutina XML jako řetězec. Pokud je streamhodnota , tato rutina vrátí pole řetězců.

XmlDocument

Ve výchozím nastavení vrátí tato rutina dokument XML.