ConvertTo-Xml

  • Referencia
Modul:
Microsoft.PowerShell.Utility

Egy objektum XML-alapú ábrázolását hozza létre.

Syntax

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

Description

A ConvertTo-Xml parancsmag egy vagy több .NET-objektum XML-alapú ábrázolását hozza létre. A parancsmag használatához egy vagy több objektumot a parancsmagba kell csöveznie, vagy az InputObject paraméter használatával adja meg az objektumot.

Ha több objektumot csövez ConvertTo-Xml az InputObject paraméterrel, vagy több objektumot küld el, ConvertTo-Xml egyetlen, memórián belüli XML-dokumentumot ad vissza, amely az összes objektum ábrázolását tartalmazza.

Ez a parancsmag hasonló az Export-Clixml parancsmaghoz, azzal a kivétellel, hogy Export-Clixml az eredményként kapott XML-fájlt egy Common Language Infrastructure (CLI) fájlban tárolja, amely újra importálható objektumként az Import-Clixml használatával. ConvertTo-Xml Egy XML-dokumentum memórián belüli ábrázolását adja vissza, így továbbra is feldolgozhatja azt a PowerShellben. ConvertTo-Xml nem rendelkezik olyan lehetőséggel, amely az objektumokat CLI XML-fájllá konvertálja.

Példák

1. példa: Dátum konvertálása XML-fájllá

Get-Date | ConvertTo-Xml

Ez a parancs az aktuális dátumot (DateTime-objektumot) XML-fájllá alakítja.

2. példa: Folyamatok konvertálása XML-fájllá

ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3

Ez a parancs xml-dokumentummá alakítja a számítógépen lévő összes folyamatot képviselő folyamatobjektumokat. Az objektumok három szintből álló mélységre vannak kibontva.

Paraméterek

-As

Meghatározza a kimeneti formátumot. A paraméter elfogadható értékei a következők:

  • String - Egyetlen sztringet ad vissza.
  • Stream - Sztringtömböt ad vissza.
  • Document- XmlDocument objektumot ad vissza.

Az alapértelmezett érték Document.

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

-Depth

Megadja, hogy hány szint tartalmazott objektumokat az XML-reprezentációban. Az alapértelmezett érték 1.

Ha például az objektum tulajdonságai is tartalmaznak objektumokat, a tartalmazott objektumok tulajdonságainak XML-reprezentációjának mentéséhez 2 mélységet kell megadnia.

Az alapértelmezett érték felülírható a Types.ps1xml fájlok objektumtípusához. További információ: about_Types.ps1xml.

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

-InputObject

A konvertálni kívánt objektumot adja meg. Adjon meg egy változót, amely tartalmazza az objektumokat, vagy írjon be egy parancsot vagy kifejezést, amely lekéri az objektumokat. Az objektumokat be is csövezheti a parancsba ConvertTo-XML.

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

-NoTypeInformation

Kihagyja a Type attribútumot az objektumcsomópontokból.

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

Bevitelek

PSObject

Bármilyen objektumot be lehet csövezni ehhez a parancsmaghoz

Kimenetek

String

Ha a As paramétert használja, és az értéket a következőre stringállítja, ez a parancsmag sztringként adja vissza az XML-t. Ha az érték az stream, ez a parancsmag sztringtömböt ad vissza.

XmlDocument

Ez a parancsmag alapértelmezés szerint egy XML-dokumentumot ad vissza.