Format-Custom

構文

Default (既定)

Format-Custom
    [[-Property] <Object[]>]
    [-Depth <Int32>]
    [-GroupBy <Object>]
    [-View <String>]
    [-ShowError]
    [-DisplayError]
    [-Force]
    [-Expand <String>]
    [-InputObject <PSObject>]
    [<CommonParameters>]

説明

例

例 1: カスタム ビューを使用して出力を書式設定する

Get-Command Start-Transcript | Format-Custom -View MyView

例 2: 既定のビューを使用して出力を書式設定する

Get-Process Winlogon | Format-Custom

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

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

ディスプレイ内の列の数を指定します。

パラメーターのプロパティ

パラメーター セット

-DisplayError

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

パラメーターのプロパティ

パラメーター セット

-Expand

コレクション オブジェクトとコレクション内のオブジェクトの書式を設定します。 このパラメーターは、System.Collections.ICollection インターフェイスをサポートするオブジェクトを書式設定するように設計されています。 既定値は EnumOnlyです。

有効な値は次のとおりです。

• EnumOnly: コレクション内のオブジェクトのプロパティを表示します。
• CoreOnly: コレクション オブジェクトのプロパティを表示します。
• 両方: コレクション オブジェクトとコレクション内のオブジェクトのプロパティを表示します。

パラメーターのプロパティ

パラメーター セット

-Force

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

パラメーターのプロパティ

パラメーター セット

-GroupBy

共有プロパティまたは値に基づいて出力をグループで書式設定します。 出力の式またはプロパティを入力します。 GroupBy パラメーターは、オブジェクトが並べ替えられていることを想定しています。 Sort-Object を使用してオブジェクトをグループ化する前に、Format-Custom コマンドレットを使用します。

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

• 名前 (またはラベル) - <string>
• Expression - <string> または <script block>
• FormatString - <string>

詳細については、「about_Calculated_Properties」を参照してください。

パラメーターのプロパティ

パラメーター セット

-InputObject

書式設定するオブジェクトを指定します。 オブジェクトを含む変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。

パラメーターのプロパティ

パラメーター セット

-Property

表示に表示されるオブジェクト プロパティと表示順序を指定します。 ワイルドカードを使用できます。

このパラメーターを省略した場合、表示に表示されるプロパティは、表示されるオブジェクトによって異なります。 パラメーター名 プロパティ は任意です。 同じコマンドでは、プロパティ パラメーターと View パラメーターを使用することはできません。

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

• Expression - <string> または <script block>
• 深さ- <int32>

詳細については、「about_Calculated_Properties」を参照してください。

パラメーターのプロパティ

パラメーター セット

-ShowError

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

パラメーターのプロパティ

パラメーター セット

-View

代替形式またはビューの名前を指定します。 このパラメーターを省略すると、Format-Custom は既定のカスタム ビューを使用します。 同じコマンドでは、プロパティ パラメーターと View パラメーターを使用することはできません。

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

PSObject

出力

Microsoft.PowerShell.Commands.Internal.Format

メモ

関連リンク

• about_Calculated_Properties
• フォーマット-ヘックス
• フォーマットリスト (Format-List)
• Format-Table
• Format-Wide
• Get-Process