Udostępnij za pośrednictwem

ConvertTo-Xml

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Tworzy reprezentację obiektu opartą na formacie XML.

Składnia

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

Opis

Polecenie cmdlet ConvertTo-Xml tworzy reprezentację opartą na formacie XML co najmniej jednego obiektu programu Microsoft .NET Framework. Aby użyć tego polecenia cmdlet, należy przekazać do polecenia cmdlet co najmniej jeden obiekt lub użyć parametru InputObject, aby określić obiekt.

Podczas przesyłania potoku wielu obiektów do ConvertTo-Xml lub używania parametru InputObject do przesyłania wielu obiektów, ConvertTo-Xml zwraca pojedynczy dokument XML zawierający reprezentacje wszystkich obiektów.

To polecenie cmdlet jest podobne do Export-Clixml z tą różnicą, że Export-Clixml przechowuje wynikowy kod XML w pliku. ConvertTo-Xml zwraca kod XML, więc możesz kontynuować jego przetwarzanie w programie PowerShell.

Przykłady

Przykład 1. Konwertowanie daty na xml

PS C:\> Get-Date | ConvertTo-Xml

To polecenie konwertuje bieżącą datę (obiekt DateTime) na XML.

Przykład 2. Konwertowanie procesów na xml

PS C:\> ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3

To polecenie konwertuje obiekty procesu, które reprezentują wszystkie procesy na komputerze do dokumentu XML. Obiekty są rozszerzane na głębokość trzech poziomów.

Parametry

-As

Określa format danych wyjściowych. Dopuszczalne wartości tego parametru to:

  • Struna. Zwraca pojedynczy ciąg.
  • Strumień. Zwraca tablicę ciągów.
  • Dokument. Zwraca obiekt XmlDocument.

Wartość domyślna to Document.

Typ:String
Dopuszczalne wartości:Stream, String, Document
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Depth

Określa, ile poziomów zawartych obiektów jest uwzględnionych w reprezentacji XML. Wartość domyślna to 1.

Jeśli na przykład właściwości obiektu zawierają również obiekty, aby zapisać reprezentację XML właściwości zawartych obiektów, należy określić głębokość 2.

Wartość domyślną można zastąpić dla typu obiektu w plikach Types.ps1xml. Aby uzyskać więcej informacji, zobacz about_Types.ps1xml.

Typ:Int32
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-InputObject

Określa obiekt, który ma zostać przekonwertowany. Wprowadź zmienną zawierającą obiekty lub wpisz polecenie lub wyrażenie, które pobiera obiekty. Można również potokować obiekty do ConvertTo-XML.

Typ:PSObject
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-NoTypeInformation

Pomija atrybut Type z węzłów obiektu.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

PSObject

Możesz przekazać dowolny obiekt do ConvertTo-XML.

Dane wyjściowe

System.String or System.Xml.XmlDocument

Wartość parametru As określa typ obiektu, który zwraca ConvertTo-XML.