Format-Custom (Microsoft.PowerShell.Utility)

Format-Custom

Модуль:: Microsoft.PowerShell.Utility

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

Синтаксис

Format-Custom
      [[-Property] <Object[]>]
      [-Depth <Int32>]
      [-GroupBy <Object>]
      [-View <String>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <String>]
      [-InputObject <PSObject>]
      [<CommonParameters>]

Описание

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

Примеры

Пример 1. Форматирование вывода с использованием пользовательского представления

Get-Command Start-Transcript | Format-Custom -View MyView

Эта команда форматирует информацию о командлете Start-Transcript в формате, определенном представлением MyView — настраиваемым представлением, созданным пользователем. Для успешного выполнения этой команды необходимо сначала создать новый файл PS1XML, определить представление MyView, а затем использовать команду Update-FormatData, чтобы добавить файл PS1XML в PowerShell.

Пример 2. Форматирование вывода с использованием представления по умолчанию

Get-Process Winlogon | Format-Custom

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

Пример 3. Устранение ошибок формата

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

PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  = #ERR
}


PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  =
}

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:01:04 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Параметры

-Depth

Указывает количество столбцов на дисплее.

Тип :: Int32
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-DisplayError

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Expand

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

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

EnumOnly: отображает свойства объектов в коллекции.
CoreOnly: отображает свойства объекта коллекции.
Оба: отображает свойства объекта коллекции и объектов в коллекции.

Тип :: String
Принятые значения:: CoreOnly, EnumOnly, оба
Позиция:: Именованный
Значение по умолчанию:: EnumOnly
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Force

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-GroupBy

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

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

Имя (или метка) — <string>
Выражение — <string> или <script; block>
ФорматСтрока — <string>

Дополнительные сведения см. в разделе about_Calculated_Properties.

Тип :: Объект
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-InputObject

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

Тип :: PSОбъект
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-Property

Указывает свойства объекта, отображаемые на экране, и порядок их появления. Подстановочные знаки разрешены.

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

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

Выражение — <string> или <script; block>
Глубина — <int32>

Дополнительные сведения см. в разделе about_Calculated_Properties.

Тип :: Object[]
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: True

-ShowError

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

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-View

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

Тип :: String
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

PSObject

В этот командлет можно передать любой объект.

Выходы

Microsoft.PowerShell.Commands.Internal.Format

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

Примечания

PowerShell включает следующие псевдонимы для Format-Custom:

Все платформы:

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

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