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 で定義されているビューを使用することも、新しい format.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
コレクション内のオブジェクトに加えてコレクション オブジェクトを書式設定します。 このパラメーターは、System.Collections.ICollection インターフェイスをサポートするオブジェクトの書式を設定するように設計されています。 既定値は 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 パラメーターの値には、新しい計算プロパティを指定できます。 計算プロパティには、スクリプト ブロックまたはハッシュ テーブルを指定できます。 有効なキーと値のペアは次のとおりです。
- 名前 (またはラベル) -
<string>
- 式 -
<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 パラメーターの値には、新しい計算プロパティを指定できます。 計算プロパティには、スクリプト ブロックまたはハッシュ テーブルを指定できます。 有効なキーと値のペアは次のとおりです。
- 式 -
<string>
または<script block>
- 深さ-
<int32>
詳細については、「about_Calculated_Properties」を参照してください。
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 |
入力
任意のオブジェクトをこのコマンドレットにパイプできます。
出力
Microsoft.PowerShell.Commands.Internal.Format
このコマンドレットは、表示を表す書式オブジェクトを返します。
メモ
PowerShell には、次のエイリアスが Format-Custom
含まれています。
- すべてのプラットフォーム:
fc
Format-Custom
は、単なるテーブルやリストではないビューを表示するように設計されています。 代替テーブル ビューを表示するには、次を使用 Format-Table
します。 代替リスト ビューを表示するには、Format-List
GroupBy パラメーターは、オブジェクトが並べ替えられていることを前提としています。 オブジェクトをグループ化するために使用 Format-Custom
する前に、それらを並べ替えるために使用 Sort-Object
します。
関連リンク
PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示