Update-FormatData

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

現在のセッションの書式設定データを更新します。

構文

Update-FormatData
      [[-AppendPath] <String[]>]
      [-PrependPath <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

このコマンドレットは Update-FormatData 、書式設定ファイルから現在のセッションに書式設定データを再読み込みします。 このコマンドレットを使用すると、PowerShell を再起動せずに書式設定データを更新できます。

パラメーターを指定しない場合は、 Update-FormatData 以前に読み込んだ書式設定ファイルを再読み込みします。 パラメーター Update-FormatData を使用して、新しい書式設定ファイルをセッションに追加できます。

フォーマット ファイルは、ファイル名拡張子を持つ XML 形式の format.ps1xml テキスト ファイルです。 ファイル内の書式設定データは、セッションでの Microsoft .NET Framework オブジェクトの表示を定義します。

PowerShell が起動すると、PowerShell ソース コードからフォーマット データが読み込まれます。 ただし、カスタム format.ps1xml ファイルを作成して、現在のセッションの書式設定を更新することはできます。 PowerShell を再起動せずに、書式設定データを現在のセッションに再読み込みするために使用 Update-FormatData できます。 このコマンドレットは、書式設定ファイルを追加または変更した後でセッションを中断したくない場合に便利です。

PowerShell でのファイルの書式設定の詳細については、「about_Format.ps1xml」を参照してください。

例

例 1: 以前に読み込まれた書式設定ファイルを再読み込みする

Update-FormatData

このコマンドは、以前に読み込まれた書式設定ファイルを再読み込みします。

例 2: フォーマット ファイルとトレースおよびログの書式設定ファイルを再読み込みする

Update-FormatData -AppendPath "trace.format.ps1xml, log.format.ps1xml"

このコマンドは、Trace.format.ps1xml と Log.format.ps1xml の 2 つの新しいファイルを含む書式設定ファイルをセッションに再読み込みします。

このコマンドでは AppendPath パラメーターを使用するため、新しいファイル内の書式設定データは、組み込みファイルの書式設定データの後に読み込まれます。

AppendPath パラメーターは、新しいファイルに組み込みファイルで参照されていないオブジェクトの書式設定データが含まれているために使用されます。

例 3: 書式設定ファイルを編集して再読み込みする

Update-FormatData -PrependPath "c:\test\NewFiles.format.ps1xml"

# Edit the NewFiles.format.ps1 file.

Update-FormatData

この例では、書式設定ファイルを編集した後で再読み込みする方法を示します。

最初のコマンドは、NewFiles.format.ps1xml ファイルをセッションに追加します。 ファイルには 組み込みファイルで参照されるオブジェクトの書式設定データが含まれているため、PrependPath パラメーターを使用します。

NewFiles.format.ps1xml ファイルを追加し、これらのセッションでテストした後、作成者はファイルを編集します。

2 番目のコマンドでは、コマンドレットを Update-FormatData 使用して書式設定ファイルを再読み込みします。 NewFiles.format.ps1xml ファイルは以前に読み込まれたため、 Update-FormatData パラメーターを使用せずに自動的に再読み込みします。

パラメーター

-AppendPath

このコマンドレットがセッションに追加するフォーマット ファイルを指定します。 ファイルは、PowerShell が組み込みの書式設定ファイルを読み込んだ後に読み込まれます。

.NET オブジェクトを書式設定する場合、PowerShell では、.NET 型ごとに検索される最初の書式設定定義が使用されます。 AppendPath パラメーターを使用すると、追加する書式設定データが検出される前に、組み込みファイルからデータが検索されます。

組み込みの書式設定ファイルで参照されない .NET オブジェクトを書式設定するファイルを追加するには、このパラメーターを使用します。

Type:String[]
Aliases:PSPath, Path
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PrependPath

このコマンドレットがセッションに追加するフォーマット ファイルを指定します。 PowerShell が組み込みの書式設定ファイルを読み込む前に、ファイルが読み込まれます。

.NET オブジェクトを書式設定する場合、PowerShell では、.NET 型ごとに検索される最初の書式設定定義が使用されます。 PrependPath パラメーターを使用すると、組み込みファイルの書式設定データが検出される前に、追加するファイルからデータが検索されます。

組み込みの書式設定ファイルでも参照される .NET オブジェクトを書式設定するファイルを追加するには、このパラメーターを使用します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

このコマンドレットへの追加パスを含む文字列をパイプ処理できます。

出力

None

このコマンドレットは、出力を返しません。

メモ

  • Update-FormatData では、モジュールからインポートされたセッション内のコマンドの書式設定データも更新されます。 モジュールのフォーマット ファイルが変更された場合は、コマンドを Update-FormatData 実行して、インポートされたコマンドの書式設定データを更新できます。 モジュールをもう一度インポートする必要はありません。