Delen via

ConvertTo-Xml

Module:
Microsoft.PowerShell.Utility Module

Hiermee maakt u een XML-weergave van een object.

Syntaxis

Default (Standaard) 

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

Description

De cmdlet ConvertTo-Xml maakt een XML- weergave van een of meer .NET-objecten. Als u deze cmdlet wilt gebruiken, geeft u een of meer objecten door aan de cmdlet of gebruikt u de parameter InputObject om het object op te geven.

Wanneer u meerdere objecten doorsluist naar ConvertTo-Xml of de parameter InputObject gebruikt om meerdere objecten te verzenden, retourneert ConvertTo-Xml één XML-document in het geheugen dat weergaven van alle objecten bevat.

Deze cmdlet is vergelijkbaar met Export-Clixml-, behalve dat Export-Clixml het resulterende XML-bestand opslaat in een CLI- bestand (Common Language Infrastructure) dat opnieuw kan worden geïmporteerd als objecten met Import-Clixml-. ConvertTo-Xml retourneert een in-memory weergave van een XML-document, zodat u het kunt blijven verwerken in PowerShell. ConvertTo-Xml geen optie heeft om objecten te converteren naar CLI XML.

Voorbeelden

Voorbeeld 1: Een datum converteren naar XML

Get-Date | ConvertTo-Xml

Met deze opdracht wordt de huidige datum (een DateTime-object) geconverteerd naar XML.

Voorbeeld 2: Processen converteren naar XML

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

Met deze opdracht worden de procesobjecten die alle processen op de computer vertegenwoordigen, geconverteerd naar een XML-document. De objecten worden uitgebreid tot een diepte van drie niveaus.

Parameters

-As

Bepaalt de uitvoerindeling. De acceptabele waarden voor deze parameter zijn:

  • String : retourneert één tekenreeks.
  • Stream : retourneert een matrix met tekenreeksen.
  • Document : retourneert een XmlDocument--object.

De standaardwaarde is Document.

Parametereigenschappen

Type:String
Default value:None
Geaccepteerde waarden:Stream, String, Document
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Depth

Hiermee geeft u op hoeveel niveaus van ingesloten objecten worden opgenomen in de XML-weergave. De standaardwaarde is 1.

Als de eigenschappen van het object bijvoorbeeld ook objecten bevatten, moet u een diepte van 2 opgeven om een XML-weergave van de eigenschappen van de ingesloten objecten op te slaan.

De standaardwaarde kan worden overschreven voor het objecttype in de types.ps1xml-bestanden. Zie about_Types.ps1xmlvoor meer informatie.

Parametereigenschappen

Type:Int32
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-InputObject

Hiermee geeft u het object dat moet worden geconverteerd. Voer een variabele in die de objecten bevat of typ een opdracht of expressie waarmee de objecten worden opgehaald. U kunt objecten ook doorslangen naar ConvertTo-Xml.

Parametereigenschappen

Type:PSObject
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-NoTypeInformation

Hiermee wordt het kenmerk Type weggelaten van de objectknooppunten.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

PSObject

U kunt elk object doorsluisen naar deze cmdlet

Uitvoerwaarden

String

Wanneer u de parameter As gebruikt en de waarde instelt op string, retourneert deze cmdlet de XML als een tekenreeks. Wanneer de waarde is stream, retourneert deze cmdlet een matrix met tekenreeksen.

XmlDocument

Deze cmdlet retourneert standaard een XML-document.