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

Синтаксис

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

Описание

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

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

Параметры

-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 может быть новым вычисляемым свойством. Чтобы создать вычисляемое свойство, используйте хэш-таблицу. Допустимые ключи:

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

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

-- FormatString <строка>

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

-ShowError

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

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

-View <string>

Задает имя альтернативного формата списка ("представления"). Использовать параметры Property и View в одной команде нельзя.

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

<CommonParameters>

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

Ввод и вывод

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

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

System.Management.Automation.PSObject

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

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

Microsoft.PowerShell.Commands.Internal.Format

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

Примечания

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

Командлеты форматирования, такие как Format-List, выполняют упорядочение данных, но не отображают их. Для отображения данных предназначены средства вывода Windows PowerShell и командлеты с именами, содержащими глагол "Out", такие как Out-Host, Out-File и Out-Printer.

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

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

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

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

Пример 1

C:\PS>get-service | format-list

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

Пример 2

C:\PS>$a = get-childitem $pshome\*.ps1xml

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

Пример 3

C:\PS>get-process | format-list -property name, basepriority, priorityclass

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

Пример 4

C:\PS>get-process winlogon | format-list -property *

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