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

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
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DisplayError

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Expand

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

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

  • EnumOnly: Отображает свойства объектов в коллекции.
  • CoreOnly: отображает свойства объекта коллекции.
  • Оба: отображает свойства объекта коллекции и объектов в коллекции.
Тип:String
Допустимые значения:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Force

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-GroupBy

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

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

  • Имя (или метка) — <string>
  • Выражение: <string> или <script block>
  • FormatString — <string>

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

Тип:Object
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-InputObject

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

Тип:PSObject
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Property

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

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

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

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

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

Тип:Object[]
Position:0
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-ShowError

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-View

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

PSObject

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

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

Microsoft.PowerShell.Commands.Internal.Format

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

Примечания

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

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

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

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