Format-Wide
オブジェクトを、各オブジェクトの 1 つのプロパティのみを表示するワイド テーブルとして書式設定します。
構文
Format-Wide
[[-Property] <Object>]
[-AutoSize]
[-Column <int>]
[-GroupBy <Object>]
[-View <string>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <string>]
[-InputObject <psobject>]
[<CommonParameters>]
説明
Format-Wide
コマンドレットは、オブジェクトを、各オブジェクトの 1 つのプロパティのみを表示するワイド テーブルとして書式設定します。
Property パラメーターを使用して、表示されるプロパティを決定できます。
例
例 1: 現在のディレクトリ内のファイルの名前を書式設定する
このコマンドは、現在のディレクトリ内のファイルの名前を画面の 3 つの列に表示します。
Get-ChildItem | Format-Wide -Column 3
Get-ChildItem コマンドレットは、ディレクトリ内の各ファイルを表すオブジェクトを取得します。 パイプライン演算子 (|) は、パイプラインを介してファイル オブジェクトを Format-Wide
に渡し、出力用に書式設定します。
Column パラメーターは、列の数を指定します。
例 2: レジストリ キーの形式名
このコマンドは、HKEY_CURRENT_USER\Software\Microsoft キーのレジストリ キーの名前を表示します。
Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize
Get-ChildItem コマンドレットは、キーを表すオブジェクトを取得します。 パスは、PowerShell レジストリ プロバイダーによって公開されるドライブの 1 つである HKCU: として指定され、その後にキー パスが続きます。 パイプライン演算子 (|) は、レジストリ キー オブジェクトをパイプライン経由で Format-Wide
に渡し、出力用に書式設定します。
Property パラメーターはプロパティの名前を指定し、AutoSize パラメーターは読みやすくするために列を調整します。
例 3: 形式エラーのトラブルシューティング
次の例は、式を使用して DisplayError または ShowError パラメーターを追加した結果を示しています。
PS /> Get-Date | Format-Wide { $_ / $null } -DisplayError
#ERR
PS /> Get-Date | Format-Wide { $_ / $null } -ShowError
Failed to evaluate expression " $_ / $null ".
+ CategoryInfo : InvalidArgument: (12/21/2018 8:18:01 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError
パラメーター
-AutoSize
データの幅に基づいて列のサイズと列数を調整します。 既定では、列のサイズと数はビューによって決まります。 同じコマンドでは、AutoSize パラメーターと Column パラメーターを使用することはできません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Column
ディスプレイ内の列の数を指定します。 同じコマンドでは、AutoSize パラメーターと Column パラメーターを使用することはできません。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DisplayError
コマンド ラインにエラーを表示します。 このパラメーターはほとんど使用されませんが、Format-Wide
コマンドで式を書式設定していて、式が機能していないように見える場合は、デバッグ支援として使用できます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Expand
コレクション オブジェクトとコレクション内のオブジェクトの書式を設定します。 このパラメーターは、ICollection (System.Collections) インターフェイスをサポートするオブジェクトの書式を設定するように設計されています。 既定値は EnumOnly
有効な値は次のとおりです。
- EnumOnly: コレクション内のオブジェクトのプロパティを表示します。
- CoreOnly: コレクション オブジェクトのプロパティを表示します。
- 両方: コレクション オブジェクトのプロパティと、コレクション内のオブジェクトのプロパティを表示します。
型: | String |
指定可能な値: | CoreOnly, EnumOnly, Both |
配置: | Named |
規定値: | EnumOnly |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Force
変更によってセキュリティが損なわれるのを防ぐために、このコマンドレットがコマンドの成功を妨げる制限をオーバーライドすることを示します。 たとえば、Force は、読み取り専用属性をオーバーライドしたり、ディレクトリを作成してファイル パスを完了したりしますが、ファイルのアクセス許可の変更は試みません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-GroupBy
共有プロパティまたは値に基づいて出力をグループで書式設定します。 出力の式またはプロパティを入力します。
GroupBy パラメーターの値には、新しい計算プロパティを指定できます。 計算されたプロパティを作成するには、ハッシュ テーブルを使用します。 このパラメーターに使用できる値は次のとおりです。
- 名前 (またはラベル) <文字列>
- 式 <文字列> または <スクリプト ブロック>
- FormatString <文字列>
型: | Object |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
書式設定するオブジェクトを指定します。 オブジェクトを含む変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。
型: | PSObject |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Property
表示に表示されるオブジェクト プロパティと表示順序を指定します。 ワイルドカードを使用できます。
このパラメーターを省略した場合、表示に表示されるプロパティは、表示されるオブジェクトによって異なります。 パラメータ名「Property」はオプションです。 同じコマンドでは、プロパティ パラメーターと View パラメーターを使用することはできません。
Property パラメーターの値には、新しい計算プロパティを指定できます。 計算プロパティを作成するには、ハッシュ テーブルを使用します。 有効なキーは次のとおりです。
- 式 <文字列> または <スクリプト ブロック>
- FormatString <文字列>
型: | Object |
配置: | 0 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-ShowError
パイプラインを介してエラーを送信します。 このパラメーターはほとんど使用されませんが、Format-Wide
コマンドで式を書式設定していて、式が機能していないように見える場合は、デバッグ支援として使用できます。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-View
代替テーブル形式またはビューの名前を指定します。 同じコマンドでは、プロパティ パラメーターと View パラメーターを使用することはできません。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
任意のオブジェクトをパイプ処理して Format-Wide
できます。
出力
Microsoft.PowerShell.Commands.Internal.Format
Format-Wide
テーブルを表す format オブジェクトを返します。
メモ
また、組み込みのエイリアス、Format-Wide
で fw
を参照することもできます。 詳細については、about_Aliasesを参照してください。
GroupBy パラメーターは、オブジェクトが並べ替えられていることを前提としています。
Format-Custom
を使用してオブジェクトをグループ化する前に、Sort-Object
を使用してください。
View パラメーターを使用すると、テーブルの代替形式を指定できます。 PowerShell ディレクトリの *.format.PS1XML
ファイルで定義されているビューを使用することも、新しい PS1XML ファイルに独自のビューを作成し、Update-FormatData
コマンドレットを使用して PowerShell に含めることもできます。
View パラメーターの代替ビューでは、テーブル形式を使用する必要があります。そうでない場合、コマンドは失敗します。 代替ビューがリストの場合は、Format-List
を使用します。 代替ビューがリストでもテーブルでもない場合は、Format-Custom を使用します。