Format-Custom
カスタマイズされたビューを使用して、出力を書式設定します。
構文
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]説明
コマンドレットは Format-Custom 、代替ビューで定義されているコマンドの出力を書式設定します。
Format-Custom は、単なるテーブルやリストではないビューを表示するように設計されています。 *形式で定義されているビューを使用できます。PowerShell ディレクトリ内の PS1XML ファイル、または新しい PS1XML ファイルに独自のビューを作成し、Update-FormatData コマンドレットを使用して PowerShell に追加できます。
例
例 1: カスタム ビューを使用して出力を書式設定する
Get-Command Start-Transcript | Format-Custom -View MyViewこのコマンドは、ユーザーによって作成された Start-Transcript カスタム ビューである MyView ビューで定義された形式でコマンドレットに関する情報を書式設定します。 このコマンドを正常に実行するには、まず新しい PS1XML ファイルを作成し、 MyView ビューを定義してから、 コマンドを Update-FormatData 使用して PS1XML ファイルを PowerShell に追加する必要があります。
例 2: 既定のビューを使用して出力を書式設定する
Get-Process Winlogon | Format-Customこのコマンドは、Winlogon プロセスに関する情報をカスタマイズされた代替ビューで書式設定します。
コマンドは View パラメーターを使用しないため、 Format-Custom 既定のカスタム ビューを使用してデータの書式設定を行います。
例 3: 形式エラーのトラブルシューティング
次の例は、式を使用して DisplayError パラメーターまたは ShowError パラメーターを追加した結果を示しています。
PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError
class DateTime
{
DayOfWeek = Friday
$_ / $null = #ERR
}
PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError
class DateTime
{
DayOfWeek = Friday
$_ / $null =
}
Failed to evaluate expression " $_ / $null ".
+ CategoryInfo : InvalidArgument: (12/21/2018 8:01:04 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionErrorパラメーター
-Depth
表示する列の数を指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayError
コマンド ラインでのエラーを表示します。 このパラメーターはほとんど使用されませんが、コマンドで Format-Custom 式を書式設定しているときに、式が機能していないように見える場合は、デバッグ支援として使用できます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Expand
コレクション内のオブジェクトに加えてコレクション オブジェクトを書式設定します。 このパラメーターは、ICollection (System.Collections) インターフェイスをサポートするオブジェクトを書式設定するために用意されています。 既定値は EnumOnly です。
有効な値は次のとおりです。
- EnumOnly: コレクション内のオブジェクトのプロパティを表示します。
- CoreOnly: コレクション オブジェクトのプロパティを表示します。
- 両方: コレクション オブジェクトのプロパティと、コレクション内のオブジェクトのプロパティを表示します。
| Type: | String |
| Accepted values: | CoreOnly, EnumOnly, Both |
| Position: | Named |
| Default value: | EnumOnly |
| 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) <文字列>
- 式 <文字列> または <スクリプト ブロック>
- FormatString <文字列>
| 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 パラメーターの値として、新しい集計プロパティを使用できます。 集計プロパティを作成するには、ハッシュ テーブルを使用します。 有効なキーは次のとおりです。
- 式 <文字列> または <スクリプト ブロック>
- Depth <int32>
| Type: | Object[] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ShowError
パイプラインを使用してエラーを送信します。 このパラメーターはほとんど使用されませんが、コマンドで Format-Custom 式を書式設定しているときに、式が機能していないように見える場合は、デバッグ支援として使用できます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-View
代替形式または "ビュー" の名前を指定します。このパラメーターを省略すると、 Format-Custom 既定のカスタム ビューが使用されます。 同じコマンドで Property パラメーターと View パラメーターを使用することはできません。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
任意のオブジェクトを Format-Custom にパイプできます。
出力
Microsoft.PowerShell.Commands.Internal.Format
Format-Custom は、表示を表す書式オブジェクトを返します。
メモ
Format-Custom は、単なるテーブルやリストではないビューを表示するように設計されています。 代替テーブル ビューを表示するには、 を使用 Format-Tableします。 代替リスト ビューを表示するには、 を使用 Format-Listします。
組み込みのエイリアス "fc" でも参照 Format-Custom できます。 詳細については、「about_Aliases」を参照してください。
GroupBy パラメーターは、オブジェクトが並べ替えられていることを前提としています。 を使用して Format-Custom オブジェクトをグループ化する前に、 を使用 Sort-Object してそれらを並べ替えます。