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
表示する列の数を指定します。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisplayError
コマンド ラインでのエラーを表示します。 このパラメーターはほとんど使用されませんが、 Format-Custom コマンドで式を書式設定していて、式が機能していないように見える場合は、デバッグ支援として使用できます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Expand
コレクション内のオブジェクトに加えてコレクション オブジェクトを書式設定します。 このパラメーターは、 System.Collections.ICollection インターフェイスをサポートするオブジェクトを書式設定するように設計されています。 既定値は EnumOnly です。
有効な値は次のとおりです。
- EnumOnly: コレクション内のオブジェクトのプロパティを表示します。
- CoreOnly: コレクション オブジェクトのプロパティを表示します。
- 両方: コレクション オブジェクトとコレクション内のオブジェクトのプロパティを表示します。
| 型: | String |
| 指定可能な値: | CoreOnly, EnumOnly, Both |
| 配置: | Named |
| 規定値: | EnumOnly |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Force
すべてのエラー情報を表示することをコマンドレットに指示します。 DisplayError または ShowError パラメーターと共に使用します。 既定では、エラー オブジェクトがエラーまたは表示ストリームに書き込まれるとき、エラー情報の一部のみが表示されます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-GroupBy
共有プロパティまたは値に基づき、グループ単位で出力を書式設定します。 式または出力のプロパティを入力します。
GroupBy パラメーターの値には、新しい計算プロパティを指定できます。 計算プロパティには、スクリプト ブロックまたはハッシュ テーブルを指定できます。 有効なキーと値のペアは次のとおりです。
- 名前 (またはラベル)
<string> - 式
<string>または<script block> - FormatString
<string>
詳細については、「 about_Calculated_Properties」を参照してください。
| 型: | Object |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
書式設定するオブジェクトを指定します。 オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。
| 型: | PSObject |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Property
表示するオブジェクト プロパティと、その表示順序を指定します。 ワイルドカードを使用できます。
このパラメーターを省略した場合、表示されるプロパティは、表示されるオブジェクトに依存します。 パラメーター名 Property は省略可能です。 同じコマンドで Property および View パラメーターを使用することはできません。
Property パラメーターの値には、新しい計算プロパティを指定できます。 計算プロパティには、スクリプト ブロックまたはハッシュ テーブルを指定できます。 有効なキーと値のペアは次のとおりです。
- 式 -
<string>または<script block> - 深さ-
<int32>
詳細については、「 about_Calculated_Properties」を参照してください。
| 型: | Object[] |
| 配置: | 0 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | True |
-ShowError
パイプラインを使用してエラーを送信します。 このパラメーターはほとんど使用されませんが、 Format-Custom コマンドで式を書式設定していて、式が機能していないように見える場合は、デバッグ支援として使用できます。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-View
代替形式またはビューの名前を指定します。 このパラメーターを省略した場合、 Format-Custom は既定のカスタム ビューを使用します。 同じコマンドで Property および View パラメーターを使用することはできません。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
任意のオブジェクトをこのコマンドレットにパイプできます。
出力
Microsoft.PowerShell.Commands.Internal.Format
このコマンドレットは、表示を表す書式オブジェクトを返します。
メモ
Windows PowerShell には、 Format-Customの次のエイリアスが含まれています。
fc
Format-Custom は、単なるテーブルやリストではないビューを表示するように設計されています。 代替テーブル ビューを表示するには、 Format-Tableを使用します。 代替リスト ビューを表示するには、 Format-Listを使用します。
GroupBy パラメーターは、オブジェクトが並べ替えられていることを前提としています。 Format-Customを使用してオブジェクトをグループ化する前に、Sort-Objectを使用して並べ替えます。
関連リンク
PowerShell