ConvertTo-XML
Erstellt eine XML-Darstellung eines Objekts.
Syntax
ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTypeInformation] [<CommonParameters>]
Beschreibung
Mit dem Cmdlet "ConvertTo-Xml" wird eine XML-Darstellung eines oder mehrerer Microsoft .NET Framework-Objekte erstellt. Um dieses Cmdlet zu verwenden, übergeben Sie mindestens ein Objekt über die Pipeline an das Cmdlet oder geben das Objekt mithilfe des InputObject-Parameters an.
Wenn Sie mehrere Objekte über die Pipeline an ConvertTo-XML übergeben oder den InputObject-Parameter verwenden, um mehrere Objekte zu senden, gibt ConvertTo-XML ein einzelnes XML-Dokument zurück, das Darstellungen aller Objekte enthält.
Dieses Cmdlet ähnelt Export-Clixml, mit der Ausnahme, dass mit Export-Clixml der resultierende XML-Inhalt in einer Datei gespeichert wird. ConvertTo-XML gibt den XML-Inhalt zurück, sodass Sie diesen anschließend in Windows PowerShell verarbeiten können.
Parameter
-As <string>
Bestimmt das Ausgabeformat. Gültige Werte:
– String: Gibt eine einzelne Zeichenfolge zurück.
– Stream: Gibt ein Zeichenfolgenarray zurück.
– Document: Gibt ein XmlDocument-Objekt zurück.
Der Standardwert ist "Stream".
Erforderlich? |
false |
Position? |
named |
Standardwert |
Stream |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Depth <int>
Gibt an, wie viele Ebenen enthaltener Objekte in die XML-Darstellung eingeschlossen werden. Der Standardwert ist 1.
Wenn beispielsweise die Eigenschaften des Objekts ebenfalls Objekte enthalten und Sie eine XML-Darstellung der Eigenschaften dieser Objekte speichern möchten, müssen Sie die Tiefe 2 angeben.
Der Standardwert für den Objekttyp kann in der Datei "Types.ps1xml" überschrieben werden. Weitere Informationen finden Sie unter "about_Types.ps1xml".
Erforderlich? |
false |
Position? |
named |
Standardwert |
1 |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-InputObject <psobject>
Gibt das zu konvertierende Objekt an. Geben Sie eine Variable ein, die die Objekte enthält, oder geben Sie einen Befehl oder einen Ausdruck ein, mit dem die Objekte abgerufen werden. Sie können Objekte auch über die Pipeline an ConvertTo-XML übergeben.
Erforderlich? |
true |
Position? |
1 |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
true (ByValue) |
Platzhalterzeichen akzeptieren? |
true |
-NoTypeInformation
Lässt das Type-Attribut in den Objektknoten weg.
Erforderlich? |
false |
Position? |
named |
Standardwert |
False |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die folgenden allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_Commonparameters.
Eingaben und Ausgaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können. Der Rückgabetyp ist der Typ der Objekte, die das Cmdlet zurückgibt.
Eingaben |
System.Management.Automation.PSObject Sie können jedes Objekt über die Pipeline an ConvertTo-XML übergeben. |
Ausgaben |
System.String oder System.Xml.XmlDocument Der Wert des As-Parameters bestimmt, welcher Objekttyp von ConvertTo-XML zurückgegeben wird. |
Beispiel 1
C:\PS>get-date | convertto-xml
Beschreibung
-----------
Mit diesem Befehl wird das aktuelle Datum (ein DateTime-Objekt) in XML konvertiert.
Beispiel 2
C:\PS>convertto-xml -as Document -inputObject (get-process) -depth 3
Beschreibung
-----------
Mit diesem Befehl werden die Prozessobjekte, die sämtliche Prozesse auf dem Computer darstellen, in ein XML-Dokument konvertiert. Die Objekte werden auf eine Tiefe von drei Ebenen erweitert.