Format-List

Ссылка

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

Форматирует вывод как список свойств, в котором каждое свойство отображается на новой строке.

Синтаксис

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

Описание

Командлет Format-List форматирует выходные данные команды в виде списка свойств, в которых каждое свойство отображается в отдельной строке. Можно использовать для Format-List форматирования и отображения всех или выбранных свойств объекта в виде списка (список форматирования *).

Так как для каждого элемента в списке доступно больше места, чем в таблице, PowerShell отображает больше свойств объекта в списке, а значения свойств менее вероятно усечены.

Примеры

Пример 1. Форматирование служб компьютеров

Get-Service | Format-List

Эта команда форматирует сведения о службах на компьютере в виде списка. По умолчанию сведения о службах форматируются в виде таблицы. Командлет Get-Service получает объекты, представляющие службы на компьютере. Оператор конвейера (|) передает результаты через конвейер Format-List. Format-List Затем команда форматирует сведения о службе в списке и отправляет их в командлет вывода по умолчанию для отображения.

Пример 2. Форматирование файлов PS1XML

Эти команды отображают сведения о файлах PS1XML в каталоге PowerShell в виде списка.

$A = Get-ChildItem $pshome\*.ps1xml
Format-List -InputObject $A

Первая команда получает объекты, представляющие файлы, и сохраняет их в переменной $A .

Вторая команда используется для Format-List форматирования сведений об объектах, хранящихся в .$A Эта команда использует параметр InputObject для передачи переменной Format-List, которая затем отправляет отформатированные выходные данные командлету вывода по умолчанию для отображения.

Пример 3. Форматирование свойств процесса по имени

Эта команда отображает имя, базовый приоритет и класс приоритета каждого процесса на компьютере.

Get-Process | Format-List -Property name, basepriority, priorityclass

Он использует Get-Process командлет для получения объекта, представляющего каждый процесс. Оператор конвейера (|) передает объекты процесса через конвейер Format-List. Format-List форматирует процессы в виде списка указанных свойств. Имя параметра Property является необязательным, поэтому его можно опустить.

Пример 4. Форматирование всех свойств для процесса

Эта команда отображает все свойства процесса Winlogon.

Get-Process winlogon | Format-List -Property *

Для получения объекта, представляющего процесс Winlogon, используется командлет Get-Process. Оператор конвейера (|) передает объект процесса Winlogon через конвейер Format-List. Команда использует параметр Property , чтобы указать свойства и *, чтобы указать все свойства. Так как имя параметра Property является необязательным, его можно опустить и ввести команду как Format-List *. Format-List автоматически отправляет результаты в командлет вывода по умолчанию для отображения.

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

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

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

DayOfWeek    : Friday
 $_ / $null  : #ERR

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

DayOfWeek    : Friday
 $_ / $null  :

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

Параметры

-DisplayError

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Expand

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

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

Type:	String
Accepted values:	CoreOnly, EnumOnly, Both
Position:	Named
Default value:	None
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 является необязательным. Нельзя использовать параметры property и View в той же команде.

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

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

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

Type:	Object[]
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ShowError

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-View

Задает имя альтернативного формата списка или представления. Нельзя использовать параметры property и View в той же команде.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

PSObject

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

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

Microsoft.PowerShell.Commands.Internal.Format

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

Примечания

Вы также можете ссылаться на Format-List по встроенному псевдониму FL. Дополнительные сведения см. в разделе about_Aliases.

Командлеты форматирования, такие как Format-List, упорядочить отображаемые данные, но не отображают их. Данные отображаются выходными функциями PowerShell и командлетами, содержащими команду Out (командлеты Out), например Out-Host .Out-File

Если вы не используете командлет формата, PowerShell применяет этот формат по умолчанию для каждого отображаемого объекта.

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

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

Альтернативное представление параметра View должно использовать формат списка, в противном случае команда завершается ошибкой. Если альтернативное представление является таблицей, используйте Format-Table. Если альтернативное представление не является списком или таблицей, используйте Format-Custom.