ConvertTo-Xml
Tworzy reprezentację obiektu opartą na języku XML.
Składnia
ConvertTo-Xml
[-Depth <Int32>]
[-InputObject] <PSObject>
[-NoTypeInformation]
[-As <String>]
[<CommonParameters>]
Opis
Polecenie ConvertTo-Xml
cmdlet tworzy opartą na języku XML reprezentację co najmniej jednego obiektu platformy .NET. Aby użyć tego polecenia cmdlet, należy przekazać do polecenia cmdlet co najmniej jeden obiekt lub użyć parametru InputObject w celu określenia obiektu.
Gdy potokujesz wiele obiektów do ConvertTo-Xml
parametru InputObject lub używasz go do przesyłania wielu obiektów, ConvertTo-Xml
zwraca pojedynczy dokument XML w pamięci, który zawiera reprezentacje wszystkich obiektów.
To polecenie cmdlet jest podobne do polecenia cmdlet Export-Clixml , z tą różnicą, że Export-Clixml
przechowuje wynikowy kod XML w pliku infrastruktury języka wspólnego (CLI), który można ponownie zaimportować jako obiekty za pomocą polecenia Import-Clixml. ConvertTo-Xml
Zwraca reprezentację dokumentu XML w pamięci, dzięki czemu można kontynuować jego przetwarzanie w programie PowerShell. ConvertTo-Xml
Nie ma opcji konwertowania obiektów na kod XML interfejsu wiersza polecenia.
Przykłady
Przykład 1. Konwertowanie daty na XML
Get-Date | ConvertTo-Xml
To polecenie konwertuje bieżącą datę (obiekt DateTime ) na XML.
Przykład 2. Konwertowanie procesów na XML
ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3
To polecenie konwertuje obiekty procesu reprezentujące wszystkie procesy na komputerze na dokument XML. Obiekty są rozszerzane na głębokość trzech poziomów.
Parametry
-As
Określa format danych wyjściowych. Dopuszczalne wartości dla tego parametru to:
String
— Zwraca pojedynczy ciąg.Stream
— Zwraca tablicę ciągów.Document
— Zwraca obiekt XmlDocument .
Wartość domyślna to Document
.
Type: | String |
Accepted values: | Stream, String, Document |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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ż przekazać obiekty potokowe do ConvertTo-XML
elementu .
Type: | PSObject |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NoTypeInformation
Pomija atrybut Type z węzłów obiektu.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Dane wejściowe
Do tego polecenia cmdlet można przekazać dowolny obiekt
Dane wyjściowe
Jeśli używasz parametru As i ustawisz wartość na string
, to polecenie cmdlet zwraca kod XML jako ciąg. Gdy wartość to stream
, to polecenie cmdlet zwraca tablicę ciągów.
Domyślnie to polecenie cmdlet zwraca dokument XML.