Создает XML-представление объекта.
Синтаксис
ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTypeInformation] [<CommonParameters>]
Описание
Командлет ConvertTo-Xml создает XML-представление одного или нескольких объектов Microsoft .NET Framework. Чтобы использовать этот командлет, передайте ему один или несколько объектов с помощью конвейера или задайте объект с помощью параметра InputObject.
При передаче командлету ConvertTo-XML нескольких объектов с помощью конвейера или использовании для этого параметра InputObject командлет ConvertTo-XML возвращает один XML-документ, содержащий представления всех объектов.
Этот командлет похож на командлет Export-Clixml, за исключением того, что Export-Clixml сохраняет полученный код XML в файл. Командлет ConvertTo-XML возвращает код XML, чтобы его можно было далее обрабатывать с помощью Windows PowerShell.
Параметры
-As <string>
Определяет формат вывода. Допустимые значения:
-- String: возвращает отдельную строку;
-- Stream: возвращает массив строк;
-- Document: возвращает объект XmlDocument.
По умолчанию используется значение Stream.
|
Обязательно? |
false |
|
Позиция? |
named |
|
Значение по умолчанию |
Stream |
|
Принимать входные данные из конвейера? |
false |
|
Принимать подстановочные знаки? |
false |
-Depth <int>
Задает число уровней вложенных объектов, которые включаются в XML-представление. По умолчанию используется значение 1.
Например, если свойства объекта также содержат объекты, то для сохранения XML-представления свойств этих вложенных объектов необходимо указать глубину, равную 2.
Значение по умолчанию можно переопределить для типа объекта в файлах Types.ps1xml. Дополнительные сведения см. в разделе about_Types.ps1xml.
|
Обязательно? |
false |
|
Позиция? |
named |
|
Значение по умолчанию |
1 |
|
Принимать входные данные из конвейера? |
false |
|
Принимать подстановочные знаки? |
false |
-InputObject <psobject>
Задает объект, подлежащий преобразованию. Введите переменную, содержащую объекты, либо команду или выражение для получения объектов. Кроме того, можно передать объекты командлету ConvertTo-XML по конвейеру.
|
Обязательно? |
true |
|
Позиция? |
1 |
|
Значение по умолчанию |
нет |
|
Принимать входные данные из конвейера? |
true (ByValue) |
|
Принимать подстановочные знаки? |
true |
-NoTypeInformation
Исключает атрибут Type из узлов объектов.
|
Обязательно? |
false |
|
Позиция? |
named |
|
Значение по умолчанию |
False |
|
Принимать входные данные из конвейера? |
false |
|
Принимать подстановочные знаки? |
false |
<CommonParameters>
Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.
Ввод и вывод
Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.
|
Входные данные |
System.Management.Automation.PSObject Любой объект можно передать командлету ConvertTo-XML по конвейеру. |
|
Выходные данные |
System.String или System.Xml.XmlDocument Значение параметра As определяет тип объекта, возвращаемого командлетом ConvertTo-XML. |
Пример 1
C:\PS>get-date | convertto-xml Описание ----------- Эта команда преобразует текущую дату (объект DateTime) в формат XML.
Пример 2
C:\PS>convertto-xml -as Document -inputObject (get-process) -depth 3 Описание ----------- Эта команда преобразует объекты процессов, представляющие все процессы на компьютере, в XML-документ. Объекты расширяются до трех уровней.
См. также