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

構文

Update-FormatData [[-AppendPath] <string[]>] [-PrependPath <string[]>] [-確認] [-WhatIf] [<CommonParameters>]

説明

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

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

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

Windows PowerShell が起動されると、Windows PowerShell インストール ディレクトリ ($pshome) にある書式設定ファイルの書式データがセッションに読み込まれます。Update-FormatData を使用すると、Windows PowerShell を再起動することなく、書式設定データを現在のセッションに再度読み込むことができます。この機能は、書式設定ファイルを追加または変更したときにセッションを中断したくない場合に便利です。

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

パラメーター

-AppendPath <string[]>

指定された書式設定ファイルをセッションに追加します。ファイルは、組み込み書式設定ファイルが読み込まれた後に読み込まれます。

.NET オブジェクトを書式設定する場合、Windows PowerShell は、それぞれの .NET 型に対して最初に検出した書式設定の定義を使用します。AppendPath パラメーターを使用した場合、Windows PowerShell は、追加する書式設定データを検出する前に、組み込みファイルのデータを検索します。

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

必須

false

位置

1

既定値

パイプライン入力を許可する

true (ByValue, ByPropertyName)

ワイルドカード文字を許可する

false

-PrependPath <string[]>

指定された書式設定ファイルをセッションに追加します。ファイルは、組み込み書式設定ファイルが読み込まれる前に読み込まれます。

.NET オブジェクトを書式設定する場合、Windows PowerShell は、それぞれの .NET 型に対して最初に検出した書式設定の定義を使用します。PrependPath パラメーターを使用した場合、Windows PowerShell は、組み込みファイルのデータを検出する前に、追加するファイルのデータを検索します。

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

必須

false

位置

named

既定値

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-確認

コマンドを実行する前に確認メッセージを表示します。

必須

false

位置

named

既定値

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。

必須

false

位置

named

既定値

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

System.String

パイプを使用して追加パスを含む文字列を Update-FormatData に渡すことができます。

出力

なし

このコマンドレットによる戻り値はありません。

注

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

例 1

C:\PS>update-formatdata

説明
-----------
このコマンドは、以前に読み込んだ書式設定ファイルを再度読み込みます。

例 2

C:\PS>update-formatdata -appendpath trace.format.ps1xml, log.format.ps1xml

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

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

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

例 3

C:\PS>update-formatdata -prependPath c:\test\NewFiles.format.ps1xml

# Edit the NewFiles.format.ps1 file.

C:\PS> update-formatdata

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

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

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

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



目次