Format-Custom
使用自定义的视图来设置输出格式。
语法
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]
说明
cmdlet Format-Custom
格式化备用视图中定义的命令输出。
Format-Custom
旨在显示不仅仅是表或列表的视图。 可以使用以 *格式定义的视图。PowerShell 目录中的 PS1XML 文件,也可以在新的 PS1XML 文件中创建自己的视图,并使用 Update-FormatData cmdlet 将它们添加到 PowerShell。
示例
示例 1:使用自定义视图设置输出格式
Get-Command Start-Transcript | Format-Custom -View MyView
此命令以 MyView 视图(由用户创建的自定义视图)定义的格式设置有关 Start-Transcript
cmdlet 的信息的格式。 若要成功运行此命令,必须先创建新的 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
设置集合对象以及集合中的对象的格式。 此参数旨在用于设置支持 ICollection (System.Collections) 接口的对象的格式。 默认值为 EnumOnly。
有效值为:
- EnumOnly:显示集合中的对象的属性。
- CoreOnly:显示集合对象的属性。
- Both:显示集合对象的属性以及集合中的对象的属性。
Type: | String |
Accepted values: | CoreOnly, EnumOnly, Both |
Position: | Named |
Default value: | EnumOnly |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
指示 cmdlet 显示所有错误信息。 与 DisplayError 或 ShowError 参数一起使用。 默认情况下,当将错误对象写入到错误或显示流时,仅显示部分错误信息。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupBy
基于共享属性或值设置组中输出的格式。 请输入表达式或输出的属性。
GroupBy 参数的值可以是新计算属性。 若要创建计算属性,请使用哈希表。 有效键包括:
- Name(或 Label)<字符串>
- Expression <字符串> 或 <脚本块>
- FormatString <字符串>
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 参数的值可以是新的计算属性。 若要创建计算属性,请使用哈希表。 有效键包括:
- Expression <字符串> 或 <脚本块>
- Depth <int32>
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
。
还可以通过其内置别名“fc”来引用 Format-Custom
。 有关详细信息,请参阅 about_Aliases。
GroupBy 参数假定对象已排序。 使用 Format-Custom
对对象进行分组之前,请使用 Sort-Object
对对象进行排序。