Format-List

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

出力の各プロパティは、新しい行に表示されるプロパティの一覧として書式設定されます。

構文

Format-List
      [[-Property] <Object[]>]
      [-GroupBy <Object>]
      [-View <string>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>]
      [<CommonParameters>]

説明

コマンドレットは Format-List 、コマンドの出力を、各プロパティが個別の行に表示されるプロパティの一覧として書式設定します。 オブジェクトのすべてのプロパティまたは選択したプロパティをリスト (Format-List -Property *) として書式設定および表示するために使用Format-Listできます。

テーブルよりもリスト内の各項目に使用できる領域が多いため、PowerShell ではリスト内のオブジェクトのプロパティが多く表示され、プロパティ値が切り捨てられる可能性は低くなります。

例

例 1: コンピューター サービスの書式設定

Get-Service | Format-List

このコマンドは、コンピューターのサービスに関する情報を一覧として書式設定します。 既定では、サービスは表として書式設定されます。 このコマンドレットは Get-Service 、コンピューター上のサービスを表すオブジェクトを取得します。 パイプライン演算子 (|) は、パイプラインを通じて結果を Format-List渡します。 次に、コマンドは Format-List リスト内のサービス情報を書式設定し、表示用の既定の出力コマンドレットに送信します。

例 2: PS1XML ファイルのフォーマット

これらのコマンドは、PowerShell ディレクトリ内の PS1XML ファイルに関する情報を一覧として表示します。

$A = Get-ChildItem $pshome\*.ps1xml
Format-List -InputObject $A

最初のコマンドは、ファイルを表すオブジェクトを取得し、変数に $A 格納します。

2 番目のコマンドは、格納されている$Aオブジェクトに関する情報を書式設定するために使用Format-Listします。 このコマンドでは、InputObject パラメーターを使用して変数をFormat-List渡し、書式設定された出力を既定の出力コマンドレットに送信して表示します。

例 3: プロセスプロパティを名前で書式設定する

このコマンドは、コンピューター上の各プロセスの名前、基本優先度、および優先度クラスを表示します。

Get-Process | Format-List -Property Name, BasePriority, PriorityClass

コマンドレットを Get-Process 使用して、各プロセスを表すオブジェクトを取得します。 パイプライン演算子 (|) は、パイプラインを介してプロセス オブジェクトを Format-List渡します。 Format-List は、指定されたプロパティの一覧としてプロセスを書式設定します。 Property パラメーター名は省略可能であるため、省略できます。

例 4: プロセスのすべてのプロパティを書式設定する

このコマンドは、Winlogon プロセスのすべてのプロパティを表示します。

Get-Process winlogon | Format-List -Property *

Get-Process コマンドレットを使用して、Winlogon プロセスを表すオブジェクトを取得します。 パイプライン演算子 (|) は、パイプラインを介して Winlogon プロセス オブジェクトを Format-List渡します。 このコマンドでは、Property パラメーターを使用してプロパティを指定し、すべてのプロパティを*示します。 Property パラメーターの名前は省略可能であるため、省略してコマンドFormat-List *を . Format-List は、結果を既定の出力コマンドレットに自動的に送信して表示します。

例 5: 形式エラーのトラブルシューティング

次の例は、式で DisplayError パラメーターまたは ShowError パラメーターを追加した結果を示しています。

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -DisplayError

DayOfWeek    : Friday
 $_ / $null  : #ERR

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -ShowError

DayOfWeek    : Friday
 $_ / $null  :

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 7:59:23 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

パラメーター

-DisplayError

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

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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

このコマンドレットがすべてのエラー情報を表示することを示します。 DisplayError または ShowError パラメーターと共に使用します。 既定では、エラー オブジェクトがエラー ストリームまたは表示ストリームに書き込まれると、一部のエラー情報のみが表示されます。

特定の .NET 型を書式設定する場合にも必要です。 詳細については、「メモ」セクションを参照してください。

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

  • Name (または Label)- <string>
  • 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-List 式を書式設定していて、式が機能していないように見える場合は、デバッグ支援として使用できます。

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-List含まれています。

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

表示するデータを配置しますが、表示しない形式のコマンドレットなど Format-Listです。 データは、PowerShell の出力機能と、動詞 (コマンドレット) を含むOutコマンドレットによって表示されます。OutたとえばOut-HostOut-File、

format コマンドレットを使用しない場合、PowerShell では、表示されるオブジェクトごとに既定の形式が適用されます。

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

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

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

Property パラメーターと共に使用Format-Listする場合は、次のいずれかの条件で Force パラメーターを含める必要があります。

  • 入力オブジェクトは、メソッドを使用して ToString() 帯域外で書式設定されます。 これは、組み込みの数値型 (.NET など) のスーパーセットである .NET プリミティブ型[int][long]に適用されます[string]。

  • 入力オブジェクトにはパブリック プロパティがありません。

  • 入力オブジェクトは、成功出力ストリーム以外の出力ストリームに PowerShell が使用するラッパー型のインスタンスです。 これは、これらのラッパー型が成功出力ストリームに送信される場合にのみ適用されます。そのためには、最初に ErrorVariable などの共通パラメーターを使用してキャプチャするか、次のような*>&1リダイレクトを使用する必要があります。