Format-List
出力の各プロパティは、新しい行に表示されるプロパティの一覧として書式設定されます。
構文
Format-List
[[-Property] <Object[]>]
[-GroupBy <Object>]
[-View <string>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <string>]
[-InputObject <psobject>]
[<CommonParameters>]説明
コマンドレットは Format-List 、コマンドの出力を、各プロパティが別の行に表示されるプロパティの一覧として書式設定します。 を使用 Format-List すると、オブジェクトのすべてのプロパティまたは選択したプロパティをリスト (Format-List -Property *) として書式設定および表示できます。
テーブルよりもリスト内の各項目に使用できる領域が多いため、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 番目のコマンドでは、 を使用 Format-List して、 に格納されているオブジェクトに関する情報を $A書式設定します。 このコマンドでは 、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 パラメーターと共に 使用します。 既定では、エラー オブジェクトがエラーまたは表示ストリームに書き込まれるとき、エラー情報の一部のみが表示されます。
| 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 は省略可能です。 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 |
入力
任意のオブジェクトを に Format-Listパイプできます。
出力
Microsoft.PowerShell.Commands.Internal.Format
Format-List は、リストを表す書式オブジェクトを返します。
メモ
組み込みのエイリアス flで をFormat-List参照することもできます。 詳細については、「about_Aliases」を参照してください。
などの Format-List形式コマンドレットは、表示するデータを配置しますが、表示しません。
データは、PowerShell の出力機能と、 や Out-FileなどのOut-Host動詞 (コマンドレット) をOut含むOutコマンドレットによって表示されます。
format コマンドレットを使用しない場合、PowerShell では、表示されるオブジェクトごとに既定の形式が適用されます。
GroupBy パラメーターは、オブジェクトが並べ替えられていることを前提としています。 を使用してオブジェクトをグループ化する前に を使用Sort-ObjectFormat-Listします。
View パラメーターを使用すると、テーブルの代替形式を指定できます。 PowerShell ディレクトリ内のファイルで定義されているビューを *.format.PS1XML 使用することも、新しい PS1XML ファイルに独自のビューを作成し、Update-FormatData コマンドレットを使用して PowerShell に含めることもできます。
View パラメーターの代替ビューではリスト形式を使用する必要があります。それ以外の場合、コマンドは失敗します。 代替ビューがテーブルの場合は、 を使用します Format-Table。 代替ビューがリストまたはテーブルでない場合は、 を使用 Format-Customします。