ConvertTo-Xml
Egy objektum XML-alapú ábrázolását hozza létre.
Syntax
Default (Alapértelmezett)
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 pipáljon egy vagy több objektumot a parancsmagba, vagy használja az InputObject paramétert az objektum megadásához.
Ha több objektumot továbbítasz a ConvertTo-Xml-n keresztül, vagy a InputObject paraméterrel küldesz, a 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, kivéve, hogy Export-Clixml az eredményként kapott XML-t egy Common Language Infrastructure (CLI) fájlban tárolja, amely objektumként újra importálható az Import-Clixmlparancsmaggal.
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 nincs lehetőség objektumok parancssori felületi XML-fájllá alakítására.
Példák
1. példa: Dátum konvertálása XML-fájllá
Get-Date | ConvertTo-Xml
Ez a parancs xml formátumba konvertálja az aktuális dátumot (DateTime objektumot).
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áromszintű mélységig vannak kibővítve.
Paraméterek
-As
Meghatározza a kimeneti formátumot. A paraméter elfogadható értékei a következők:
-
String– Egyetlen karakterláncot ad vissza. -
Stream– Sztringtömböt ad vissza. -
Document– Egy XmlDocument objektumot ad vissza.
Az alapértelmezett érték a Document.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Elfogadott értékek: | Stream, String, Document |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Depth
Meghatározza, hogy hány szint tartalmaz 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ókért lásd a about_Types.ps1xmlrészt.
Paramétertulajdonságok
| Típus: | Int32 |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 ConvertTo-XML-ba is továbbíthatja.
Paramétertulajdonságok
| Típus: | PSObject |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | True |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-NoTypeInformation
Kihagyja a Type attribútumot az objektumcsomópontokból.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
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 stringértékre állítja, ez a parancsmag sztringként adja vissza az XML-t. Ha az érték stream, ez a parancsmag sztringtömböt ad vissza.
XmlDocument
Ez a parancsmag alapértelmezés szerint egy XML-dokumentumot ad vissza.