Format-Custom

项目
10/30/2009

使用自定义视图来设置输出的格式。

语法

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

说明

Format-Custom cmdlet 将根据可选视图中的定义来设置命令输出的格式。Format-Custom 用于显示不是仅为表格或仅为列表的视图。可使用 Windows PowerShell 目录中的 *format.PS1XML 文件中定义的视图，或者可在新的 PS1XML 文件中创建自己的视图，并使用 Update-FormatData cmdlet 将它们添加到 Windows PowerShell 中。

参数

-Depth <int>

指定显示的列数。

是否为必需？	false
位置？	named
默认值
是否接受管道输入？	false
是否接受通配符？	false

-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 参数的值可以是新的计算属性。若要创建计算属性，请使用哈希表。有效键包括：

-- Expression <字符串> 或 <脚本块>

-- Depth <int32>

是否为必需？	false
位置？	1
默认值
是否接受管道输入？	false
是否接受通配符？	false

-ShowError

通过管道发送错误。

是否为必需？	false
位置？	named
默认值
是否接受管道输入？	false
是否接受通配符？	false

-View <string>

指定可选格式或“视图”的名称。如果省略此参数，则 Format-Custom 将使用默认的自定义视图。不能在同一命令中使用 Property 和 View 参数。

是否为必需？	false
位置？	named
默认值
是否接受管道输入？	false
是否接受通配符？	false

<CommonParameters>

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

输入和输出

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

输入

System.Management.Automation.PSObject

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

输出

Microsoft.PowerShell.Commands.Internal.Format

Format-Custom 返回表示显示的格式对象。

说明

Format-Custom 用于显示那些不是仅为表格或仅为列表的视图。若要显示可选表格视图，请使用 Format-Table。若要显示可选列表视图，请使用 Format-List。

还可以使用内置别名“fc”来引用 Format-Custom。有关详细信息，请参阅 about_Aliases。

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

示例 1

C:\PS>get-command start-transcript | format-custom -view MyView

说明
-----------
此命令使用 MyView 视图（一种由用户创建的自定义视图）定义的格式来设置 Start-Transcript cmdlet 的相关信息的格式。若要成功运行此命令，必须首先创建新的 PS1XML 文件，定义 MyView 视图，然后使用 Update-FormatData 命令将该 PS1XML 文件添加到 Windows PowerShell 中。

示例 2

C:\PS>get-process Winlogon | format-custom

说明
-----------
此命令将设置可选自定义视图中有关 Winlogon 进程的信息的格式。由于该命令未使用 View 参数，因此 Format-Custom 将使用默认的自定义视图来设置数据的格式。

通过