Update-FormatData

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

構文

Default (既定)

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

説明

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

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

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

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

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 オブジェクトの書式を設定するファイルを追加します。

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

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:PSPath, Path

パラメーター セット

(All)
配置:0
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Confirm

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

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

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
エイリアス:Cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PrependPath

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

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

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

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

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
エイリアス:wi

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

String

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

出力

None

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

メモ

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

Warning

JEA などの制限付きエンドポイントでは、 Update-FormatData コマンドを公開しないでください。 このコマンドを使用すると、 ScriptBlock 要素を型の書式設定に追加できます。 セッションがより制限の厳しい言語モードを使用するように構成されている場合でも、 ScriptBlock は FullLanguage モードで評価される場合があります。