Format-Wide 帮助信息

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

译者 : Edengundam( 马涛 )

 

Format-Wide

 

摘要

将对象格式化为每个对象只显示一个属性的宽表 .

 

语法

Format-Wide [[-property] <Object>] [-autosize] [-column <int>] [-groupBy <Object>] [-view <string>] [-force] [-inputObject <psobject>] [-expand <string>] [-displayError] [-showError] [<CommonParameters>]

 

详细描述

Format-Wide cmdlet 将对象格式化为每个对象只显示一个属性的宽表 . 你可以使用 Property 参数来决定需要显示的属性 .

 

参数

 

-property <Object>

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

 

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

 

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

 

-autosize <SwitchParameter>

根据数据的宽度调整列尺寸和列数 . 默认情况下 , 列尺寸和列数通过视图确定 . 你不能在同一个命令中同时使用 Autosize 和 Column 参数 .

 

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

 

-column <int>

指定在屏幕上显示的列数 . 你不能在同一个命令中同时使用 Autosize 和 Column 参数 .

 

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

 

-groupBy <Object>

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

 

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

 

-view <string>

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

 

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

 

-force <SwitchParameter>

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

 

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

 

-inputObject <psobject>

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

 

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

 

-expand <string>

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

 

合法取值 :

 

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

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

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

 

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

 

-displayError <SwitchParameter>

在命令行上显示错误 .

 

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

 

-showError <SwitchParameter>

通过管道发送错误 .

 

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

 

< 公共参数 >

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

 

输入类型

Object

 

返回类型

格式化后的对象

 

注意

 

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

 

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

 

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

 

参数 -Groupby 假设对象已经排序 . 在使用 Format-Custom 对对象进行分组前 , 使用 Sort-Object 将它们排序 .

 

参数 -View 允许您指定表的可选格式 . 你可以使用定义在 Windows PowerShell 目录中 *.format.PS1XML 文件中的格式 , 或者创建属于你自己的 PS1XML 文件 , 并使用 Update-FormatData cmdlet 将它们添加到 Windows PowerShell 中 .

 

参数 View 使用的可选视图必须是表格式 ; 如果不是 , 命令将会执行失败 . 如果可选视图为列表 , 使用 Format-List . 如果可选视图既不是列表也不是表 , 使用 Format-Custom .

 

例 1

 

C:/PS>get-childitem | format-wide -column 3

 

此命令将当前目录中的文件分成三列显示在屏幕上 . Get-Childitem cmdlet 取得表示目录中每个文件的对象 . 管道运算符 (|) 将文件对象通过管道发送给 Format-Wide, 后者将它们格式化 , 以便输出 . 参数 Column 指定列数 .

 

例 2

 

C:/PS>get-childitem HKCU:/software/microsoft | format-wide -property pschildname -autosize

 

此命令将会显示 HKEY_CURRENT_USER/Software/Microsoft 项中的注册表项的名称 . Get-Childitem cmdlet 取得表示注册表项的对象 . 路径指定了 "HKCU:"(Windows PowerShell 注册表提供程序公开的驱动器 ), 后面跟随着注册表项的路径 . 管道运算符 (|) 将注册表项对象通过管道发送给 Format-Wide, 后者对它们进行个时候 , 以便输出 . 参数 Property 指定了属性的名称 , 参数 Autosize 自动调整列数 , 方便阅读 .

 

相关链接

Format-Custom

Format-Table

Format-List

Out-Host

Out-File