Format-Custom
使用自定义视图设置输出的格式。
语法
Default (默认值)
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]
说明
Format-Custom cmdlet 将命令的输出格式化为备用显示中定义的格式。
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
指定显示中的列数。
参数属性
| 类型: | Int32 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DisplayError
在命令行中显示错误。 此参数很少使用,但当你在 Format-Custom 命令中设置表达式的格式时,可用作调试辅助,并且表达式似乎不起作用。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Expand
设置集合对象以及集合中的对象的格式。 此参数旨在设置支持 ICollection (System.Collections) 接口的对象的格式。 默认值为 EnumOnly。
有效值为:
- EnumOnly:显示集合中的对象的属性。
- CoreOnly:显示集合对象的属性。
- 两者:显示集合对象的属性和集合中对象的属性。
参数属性
| 类型: | String |
| 默认值: | EnumOnly |
| 接受的值: | CoreOnly, EnumOnly, Both |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Force
指示 cmdlet 显示所有错误信息。 与 DisplayError 或 ShowError 参数一起使用。 默认情况下,当错误对象被写入错误日志或显示日志时,仅会显示部分错误信息。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-GroupBy
根据共享属性或值在组中设置输出的格式。 输入输出的表达式或属性。
GroupBy 参数的值可以是新的计算属性。 若要创建计算属性,请使用哈希表。 有效密钥包括:
- 名称(或标签)<字符串>
- 表达式 <字符串> 或 <脚本块>
- FormatString <字符串>
参数属性
| 类型: | Object |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-InputObject
指定要设置格式的对象。 输入一个包含对象的变量,或键入一个获取对象的命令或表达式。
参数属性
| 类型: | PSObject |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Property
指定显示在显示中的对象属性及其显示顺序。 允许使用通配符。
如果省略此参数,显示中显示的属性取决于所显示的对象。 参数名称(“Property”)是可选的。 不能在同一命令中使用 属性 和 视图 参数。
Property 参数的值可以是新的计算属性。 若要创建计算属性,请使用哈希表。 有效密钥包括:
- 表达式 <字符串> 或 <脚本块>
- 深度 <int32>
参数属性
| 类型: | Object[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
(All)
| Position: | 0 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ShowError
通过管道发送错误。 此参数很少使用,但当你在 Format-Custom 命令中设置表达式的格式时,可用作调试辅助,并且表达式似乎不起作用。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-View
指定备用格式或“视图”的名称。如果省略此参数,Format-Custom 使用默认自定义视图。 不能在同一命令中使用 属性 和 视图 参数。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输入
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 对其进行排序。