Format-List

将输出的格式设置为属性列表,其中每个属性均各占一行显示。

语法

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

说明

Format-List cmdlet 将命令输出的格式设置为属性列表,其中每个属性均各占一行进行显示。可使用 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

使 cmdlet 显示所有错误信息。与 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>

此 cmdlet 支持通用参数:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息,请参阅 about_Commonparameters.

输入和输出

输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。

输入

System.Management.Automation.PSObject

可以通过管道将任何对象传递给 Format-List。

输出

Microsoft.PowerShell.Commands.Internal.Format

Format-List 返回表示列表的格式对象。

说明

也可使用它的内置别名“FL”来引用 Format-List。有关详细信息,请参阅 about_Aliases。

格式 cmdlet(例如 Format-List)可以排列要显示的数据,但并不实际显示它。数据可通过 Windows PowerShell 的输出功能和包含 Out 动词的 cmdlet(输出 cmdlet,如 Out-Host、Out-File 和 Out-Printer)来显示。

若未使用 format cmdlet,则 Windows PowerShell 将对要显示的每个对象应用默认格式。

GroupBy 参数假定对象已经过排序。在使用 Format-Custom 对对象进行分组之前,请使用 Sort-Object 对它们进行排序。

使用 View 参数可以指定表的可选格式。可使用 Windows PowerShell 目录中的 *.format.PS1XML 文件中定义的视图,或者可在新的 PS1XML 文件中创建自己的视图,并使用 Update-FormatData cmdlet 将它们包括在 Windows PowerShell 中。

View 参数的可选视图必须使用列表格式,否则,该命令将失败。如果可选视图为表,请使用 Format-Table。如果可选视图既不是列表也不是表,请使用 Format-Custom。

示例 1

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

说明
-----------
此命令将计算机上服务的相关信息设置为列表格式。默认情况下,将这些服务设置为表视图格式。Get-Service cmdlet 可获取表示计算机上的服务的对象。管道运算符 (|) 通过管道将结果传递给 Format-List。随后,Format-List 命令将服务信息设置为列表格式,并将其发送到默认的输出 cmdlet 以进行显示。





示例 2

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

说明
-----------
这些命令将以列表形式显示 Windows PowerShell 目录中 PS1XML 文件的相关信息。第一条命令将获取表示该文件的对象,并将它们存储在 $a 变量中。第二个命令使用 Format-List 来设置存储在 $a 中对象的相关信息的格式。此命令使用 InputObject 参数将该变量传递给 Format-List,后者随后将已设置格式的输出发送到默认的输出 cmdlet 以进行显示。





示例 3

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

说明
-----------
此命令将显示计算机上每个进程的名称、基本优先级和优先级类。它使用 Get-Process cmdlet 来获取表示每个进程的对象。管道运算符 (|) 通过管道将进程对象传递给 Format-List。Format-List 将进程的格式设置为指定属性的列表。“Property”参数名为可选项,因此可将其省略。





示例 4

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

说明
-----------
此命令显示 Winlogon 进程的所有属性。它使用 Get-Process cmdlet 来获取表示 Winlogon 进程的对象。管道运算符 (|) 通过管道将 Winlogon 进程对象传递给 Format-List。该命令使用 Property 参数来指定属性,并使用 * 表示所有属性。由于 Property 参数的名称为可选项,因此可将其省略,并键入命令“format-list *”。Format-List 自动将结果发送到默认的输出 cmdlet 以进行显示。