Format-Custom
Использует пользовательское представление для форматирования выходных данных.
Синтаксис
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
файле и добавить их в PowerShell с помощью Update-FormatData
командлета .
Примеры
Пример 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
Задает количество столбцов в отображаемых данных.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayError
Отображает сообщения об ошибках в командной строке. Этот параметр используется редко, но его можно использовать в качестве средства отладки при форматировании выражений Format-Custom
в команде, а выражения не работают.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Expand
Форматирует объект коллекции, а также объекты, содержащиеся в коллекции. Этот параметр предназначен для форматирования объектов, поддерживающих интерфейс System.Collections.ICollection . Значение по умолчанию — EnumOnly.
Допустимые значения:
- EnumOnly — отображаются свойства объектов в коллекции.
- CoreOnly — отображаются свойства объекта коллекции.
- Оба: отображает свойства объекта коллекции и объектов в коллекции.
Type: | String |
Accepted values: | CoreOnly, EnumOnly, Both |
Position: | Named |
Default value: | EnumOnly |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Заставляет командлет отображать полные сведения об ошибках. Используйте с параметрами DisplayError или ShowError . По умолчанию при записи объекта ошибки в поток ошибок или поток отображения отображаются только некоторые сведения об ошибке.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupBy
Форматирует вывод в группы на основе общего свойства или значения. Введите выражение или свойство вывода.
Значение параметра GroupBy может быть новым вычисляемым свойством. Вычисляемое свойство может быть блоком скрипта или хэш-таблицей. Допустимые пары "ключ-значение":
- Имя (или метка) —
<string>
- Выражение —
<string>
или<script block>
- Formatstring-
<string>
Дополнительные сведения см. в разделе about_Calculated_Properties.
Type: | Object |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Задает объекты, подлежащие форматированию. Введите переменную, которая содержит объекты, или команду или выражение, которое возвращает объекты.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Property
Задает свойства объекта, которые будут включены в вывод, и порядок их вывода. Разрешено использовать подстановочные знаки.
Если этот параметр не указан, свойства включаются в вывод в зависимости от отображаемого объекта. Имя параметра Свойство является необязательным. Нельзя использовать параметры Property и View в одной команде.
Значение параметра Property может быть новым вычисляемым свойством. Вычисляемое свойство может быть блоком скрипта или хэш-таблицей. Допустимые пары "ключ-значение":
- Выражение —
<string>
или<script block>
- Глубина-
<int32>
Дополнительные сведения см. в разделе about_Calculated_Properties.
Type: | Object[] |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-ShowError
Отправляет ошибки по конвейеру. Этот параметр используется редко, но его можно использовать в качестве средства отладки при форматировании выражений Format-Custom
в команде, а выражения не работают.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-View
Указывает имя альтернативного формата или представления. Если этот параметр не указан, Format-Custom
используется настраиваемое представление по умолчанию. Нельзя использовать параметры Property и View в одной команде.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
Вы можете передать любой объект в 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
их сортировки.