Format-Custom

Статья
10/30/2009

Использует пользовательское представление для форматирования вывода.

Синтаксис

Format-Custom [[-Property] <Object[]>] [-Depth <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]

Описание

Командлет Format-Custom форматирует выходные данные команды в соответствии альтернативными с правилами представления. Format-Custom позволяет задать нестандартное отображение данных, отличное от простых таблиц и списков. Можно использовать представления, определенные в файлах *format.PS1XML в каталоге Windows PowerShell, или создать собственные представления в новых файлах PS1XML и добавить их в Windows PowerShell с помощью командлета Update-FormatData.

Параметры

-Depth <int>

Задает число столбцов в отображаемых данных.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-DisplayError

Выводит сообщения об ошибках в командной строке.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-Expand <string>

Форматирует объект коллекции, а также объекты, содержащиеся в коллекции. Этот параметр служит для форматирования объектов, поддерживающих интерфейс ICollection (System.Collections). По умолчанию используется значение "EnumOnly".

Допустимые значения:

-- EnumOnly: отображаются свойства объектов, содержащихся в коллекции;

-- CoreOnly: отображаются свойства объекта коллекции;

-- Both: отображаются свойства объекта коллекции и свойства объектов, содержащихся в коллекции.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-Force

Приводит к отображению командлетом полных сведений об ошибках. Используется с параметром DisplayError или ShowError. По умолчанию при записи объекта ошибки в поток ошибок или поток отображения отображаются только некоторые сведения об ошибке.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-GroupBy <Object>

Форматирует вывод в группы на основе общего свойства или значения. Введите выражение или свойство вывода.

Значение параметра GroupBy может быть новым вычисляемым свойством. Чтобы создать вычисляемое свойство, используйте хэш-таблицу. Допустимые ключи:

-- Name (или Label) <строка>

-- Expression <строка> или <блок скрипта>

-- FormatString <строка>

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-InputObject <psobject>

Задает объекты, подлежащие форматированию. Введите переменную, содержащую объекты, либо получающую их команду или выражение.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	true (ByValue)
Принимать подстановочные знаки?	false

-Property <Object[]>

Задает свойства объекта, которые будут включены в вывод, и порядок их вывода. Подстановочные знаки разрешены.

Если этот параметр не указан, включаемые в вывод свойства зависят от отображаемого объекта. Имя параметра ("Property") указывать необязательно. Использовать параметры Property и View в одной команде нельзя.

Значение параметра Property может быть новым вычисляемым свойством. Чтобы создать вычисляемое свойство, используйте хэш-таблицу. Допустимые ключи:

-- Expression <строка> или <блок скрипта>

-- Depth <int32>

Обязательно?	false
Позиция?	1
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-ShowError

Отправляет ошибки по конвейеру.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-View <string>

Задает имя альтернативного формата ("представления"). Если этот параметр не указан, командлет Format-Custom выбирает пользовательское представление по умолчанию. Использовать параметры Property и View в одной команде нельзя.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

<CommonParameters>

Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.

Ввод и вывод

Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.

Входные данные

System.Management.Automation.PSObject

Любой объект можно передать командлету Format-Custom по конвейеру.

Выходные данные

Microsoft.PowerShell.Commands.Internal.Format

Командлет Format-Custom возвращает объекты формата, представляющие отображение данных.

Примечания

Командлет Format-Custom позволяет задать нестандартное отображение данных, отличное от простых таблиц и списков. Для вывода альтернативного представления в виде таблицы используйте командлет Format-Table. Для вывода альтернативного представления в виде списка используйте командлет Format-List.

Командлет Format-Custom также можно вызывать с помощью встроенного псевдонима "fc". Дополнительные сведения см. в разделе about_Aliases.

При указании параметра GroupBy предполагается, что объекты отсортированы. Перед группировкой объектов с помощью командлета Format-Custom выполните командлет Sort-Object, чтобы отсортировать их.

Пример 1

C:\PS>get-command start-transcript | format-custom -view MyView

Описание
-----------
Эта команда представляет сведения о командлете Start-Transcript в формате пользовательского представления MyView. Чтобы эта команда выполнилась без ошибок, нужно создать новый файл PS1XML, определить представление MyView, а затем добавить файл PS1XML в Windows PowerShell с помощью команды Update-FormatData.

Пример 2

C:\PS>get-process Winlogon | format-custom

Описание
-----------
Эта команда представляет сведения о процессе Winlogon в формате альтернативного пользовательского представления. Так как она не содержит параметр View, для форматирования данных с помощью командлета Format-Custom используется пользовательское представление по умолчанию.

Поделиться через