ConvertTo-Xml

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

Tworzy reprezentację obiektu opartą na formacie XML.

Składnia

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

Opis

Polecenie ConvertTo-Xml cmdlet tworzy reprezentację opartą na formacie XML 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 , aby określić obiekt.

Podczas przesyłania potoku wielu obiektów do ConvertTo-Xml lub użycia parametru InputObject do przesyłania wielu obiektów ConvertTo-Xml zwraca pojedynczy dokument XML w pamięci zawierający 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, 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:

  • String — Zwraca pojedynczy ciąg.
  • Stream - Zwraca tablicę ciągów.
  • Document — Zwraca obiekt XmlDocument .

Domyślna wartość 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. Domyślna wartość wynosi 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-XMLobiektu .

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

PSObject

Do tego polecenia cmdlet można przekazać dowolny obiekt

Dane wyjściowe

String

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.

XmlDocument

Domyślnie to polecenie cmdlet zwraca dokument XML.