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 パラメーターを使用することはできません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Column

表示する列の数を指定します。 同じコマンドで AutoSize パラメーターと Column パラメーターを使用することはできません。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayError

コマンド ラインでのエラーを表示します。 このパラメーターはほとんど使用されませんが、コマンドで Format-Wide 式を書式設定していて、式が機能していないように見える場合は、デバッグ支援として使用できます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expand

コレクション内のオブジェクトに加えてコレクション オブジェクトを書式設定します。 このパラメーターは、System.Collections.ICollection インターフェイスをサポートするオブジェクトの書式を設定するように設計されています。 既定値は 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

変更によってセキュリティが損なわれるのを防ぐために、このコマンドレットがコマンドの成功を妨げる制限をオーバーライドすることを示します。 たとえば、 Force は読み取り専用属性をオーバーライドするか、ディレクトリを作成してファイル パスを完了しますが、ファイルのアクセス許可の変更は試行しません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupBy

共有プロパティまたは値に基づき、グループ単位で出力を書式設定します。 式または出力のプロパティを入力します。

GroupBy パラメーターの値には、新しい計算プロパティを指定できます。 計算プロパティには、スクリプト ブロックまたはハッシュ テーブルを指定できます。 有効なキーと値のペアは次のとおりです。

  • Name (または Label)- <string>
  • Expression - <string> または <script block>
  • FormatString - <string>

詳細については、「about_Calculated_Properties」を参照してください

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 パラメーターと View パラメーターを使用することはできません。

Property パラメーターの値には、新しい計算プロパティを指定できます。 計算プロパティには、スクリプト ブロックまたはハッシュ テーブルを指定できます。 有効なキーと値のペアは次のとおりです。

  • Expression - <string> または <script block>
  • FormatString - <string>

詳細については、「about_Calculated_Properties」を参照してください

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

パイプラインを使用してエラーを送信します。 このパラメーターはほとんど使用されませんが、コマンドで Format-Wide 式を書式設定していて、式が機能していないように見える場合は、デバッグ支援として使用できます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-View

代替テーブル形式またはビューの名前を指定します。 同じコマンドで Property パラメーターと View パラメーターを使用することはできません。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSObject

任意のオブジェクトをこのコマンドレットにパイプできます。

出力

Microsoft.PowerShell.Commands.Internal.Format

このコマンドレットは、テーブルを表す書式オブジェクトを返します。

メモ

PowerShell には、次のエイリアスが Format-Wide含まれています。

  • すべてのプラットフォーム:
    • fw

GroupBy パラメーターは、オブジェクトが並べ替えられていることを前提としています。 オブジェクトをグループ化するために使用する前に使用Sort-ObjectFormat-Customします。

View パラメーターを使用すると、テーブルの代替形式を指定できます。 PowerShell ディレクトリ内のファイルで定義されているビューを *.format.PS1XML 使用することも、新しい PS1XML ファイルに独自のビューを作成し、コマンドレットを Update-FormatData 使用して PowerShell に含めることもできます。

View パラメーターの代替ビューでは、テーブル形式を使用する必要があります。使用しない場合、コマンドは失敗します。 代替ビューがリストの場合は、Format-List 代替ビューがリストでもテーブルでもない場合は、Format-Custom