Format-Custom 帮助信息

 

如下说明是翻译 PowerShell 中 : help Format-Custom 产生的帮助信息 .

译者 : Edengundam( 马涛 )

 

Format-Custom

 

摘要

使用自定义视图格式化输出 .

 

语法

Format-Custom [[-property] <Object[]>] [-inputObject <psobject>] [-view <string>] [-groupBy <Object>] [-force] [-expand <string>] [-displayError] [-showError] [-depth <int>] [<CommonParameters>]

 

详细描述

Format-Custom cmdlet 根据可选视图格式化命令输出 . Format-Custom 并非设计为仅仅显示表格或列表的视图 . 你可以使用定义在 Windows PowerShell 目录中的 *format.PS1XML 文件或你在新的 PS1XML 文件中创建的自定义视图 , 并通过使用 Update-FormatData cmdlet 将它们添加到 Windows PowerShell 中 .

 

参数

 

-property <Object[]>

指定要在屏幕上显示的对象属性及其显示顺序 . 允许使用通配符 . 

 

如果你忽略此参数 , 屏幕上显示的属性将会根据需要显示的对象决定 . 参数名称 ("-Property") 为可选项 . 你不能在同一个命令中同时使用 Property 和 View 参数 .

 

强制参数 ?	false
参数位置 ?	1
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-inputObject <psobject>

指定需要格式化的对象 . 输入一个包含对象的变量 , 或者一个能够产生对象的命令或表达式 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	true ( 根据值 )
允许通配符扩展 ?	false

 

-view <string>

指定其他的表格式 ( 或视图 ). 你不能在同一个命令中同时使用 Property 和 View 参数 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-groupBy <Object>

根据共享的属性或值将输出结果进行分组 . 输入一个表达式或输出的属性 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-force <SwitchParameter>

在不破坏安全前提下 , 能够避免影响命令成功执行的限制条件 . 例如 : Force 参数能够覆盖具有只读属性的文件或创建路径中的必要成分 , 但是不会改变人和文件的权限 .

 

强制参数 ?	false
参数位置 ?	named
默认值	False
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-expand <string>

格式化集合和集合中元素 . 设计此参数用于格式化那些支持 ICollection(System.Collections) 接口的对象 .

 

合法取值 :

 

·          Enum ( 默认 ): 显示集合中元素的属性 .

·          Core: 显示集合对象的属性 .

·          Both: 显示集合和集合中元素的属性 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-displayError <SwitchParameter>

在命令行上显示错误 .

 

强制参数 ?	false
参数位置 ?	named
默认值	False
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-showError <SwitchParameter>

通过管道发送错误 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-depth <int>

指定显示的列数 .

 

强制参数 ?	false
参数位置 ?	named
默认值	ComplexSpecificParameters.maxDepthAllowable
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

< 公共参数 >

此命令支持公共参数 : -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. 更多信息 , 输入 , "get-help about_commonparameters".

 

输入类型

Object

 

返回类型

Objects

 

注意

 

Format-Custom 并非设计为仅仅显示表格或列表的视图 . 要显示可选表格视图 , 可以使用 Format-Table. 要显示可选列表 , 可以使用 Format-List.

 

更多信息 , 输入 "Get-Help Format-Custom -detailed". 需要技术信息 , 输入 "Get-Help Format  -Custom -full".

 

如果需要为该命令提供多个参数 , 请使用逗号进行分隔 . 例如 : "<parameter-name> <value1>, <value2>".

 

你可以使用 Format-Custom 内建别名 : "fc". 需要更多信息 , 查看 About_Alias.

 

参数 -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 使用默认自定义视图格式化数据 .

 

相关链接

Format-List

Format-Wide

Format-Table