Export-FormatData

モジュール:

Microsoft.PowerShell.Utility

現在のセッションの書式設定データを書式設定ファイルに保存します。

構文

Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -Path <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]

Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -LiteralPath <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]

説明

Export-FormatData コマンドレットは、現在のセッションの書式設定オブジェクトから PowerShell 書式設定ファイル (format.ps1xml) を作成します。 ExtendedTypeDefinition オブジェクト Get-FormatData 取得し、XML 形式でファイルに保存します。

PowerShell では、フォーマット ファイル (format.ps1xml) のデータを使用して、セッション内の Microsoft .NET Framework オブジェクトの既定の表示を生成します。 書式設定ファイルを表示および編集したり、Update-FormatData コマンドレットを使用して書式設定データをセッションに追加したりできます。

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

例

例 1: セッション形式データをエクスポートする

Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock

このコマンドは、セッション内のすべてのフォーマット データを AllFormat.ps1xml ファイルにエクスポートします。

このコマンドでは、Get-FormatData コマンドレットを使用して、セッション内のフォーマット データを取得します。 TypeName パラメーターの値が * (all) の場合、コマンドレットはセッション内のすべてのデータを取得するように指示します。

このコマンドでは、パイプライン演算子 (|) を使用して、Get-FormatData コマンドからフォーマット データを Export-FormatData コマンドレットに送信し、形式データを AllFormat.ps1 ファイルにエクスポートします。

Export-FormatData コマンドは、IncludeScriptBlock パラメーターを使用して、ファイル内のフォーマット データにスクリプト ブロックを含めます。

例 2: 型の書式データをエクスポートする

$F = Get-FormatData -TypeName "helpinfoshort"
Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlock

これらのコマンドは、HelpInfoShort 型の書式データを Help.format.ps1xml ファイルにエクスポートします。

最初のコマンドでは、Get-FormatData コマンドレットを使用して、HelpInfoShort 型の書式データを取得し、$F 変数に保存します。

2 番目のコマンドでは、Export-FormatData コマンドレットの InputObject パラメーターを使用して、$F 変数に保存された書式データを入力します。 また、IncludeScriptBlock パラメーターを使用して、スクリプト ブロックを出力に含めます。

例 3: スクリプト ブロックなしでフォーマット データをエクスポートする

Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path process.format.ps1xml
Update-FormatData -PrependPath ".\process.format.ps1xml"
Get-Process p*

Handles  NPM(K)  PM(K)  WS(K) VM(M)   CPU(s)    Id ProcessName
-------  ------  -----  ----- -----   ------    -- -----------
323                                       5600 powershell
336                                       3900 powershell_ise
138                                       4076 PresentationFontCache

この例では、Export-FormatData コマンドから IncludeScriptBlock パラメーターを省略した場合の効果を示します。

最初のコマンドでは、Get-FormatData コマンドレットを使用して、Get-Process コマンドレットが返す System.Diagnostics.Process オブジェクトの形式データを取得します。 このコマンドでは、パイプライン演算子 (|) を使用して書式設定データを Export-FormatData コマンドレットに送信し、現在のディレクトリの Process.format.ps1xml ファイルにエクスポートします。

この場合、Export-FormatData コマンドは IncludeScriptBlock パラメーターを使用しません。

2 番目のコマンドでは、Update-FormatData コマンドレットを使用して、Process.format.ps1xml ファイルを現在のセッションに追加します。 このコマンドでは、PrependPath パラメーターを使用して、Process.format.ps1xml ファイル内のプロセス オブジェクトの書式設定データが、プロセス オブジェクトの標準の書式設定データの前に見つかっていることを確認します。

3 番目のコマンドは、この変更の影響を示しています。 このコマンドは、Get-Process コマンドレットを使用して、P で始まる名前を持つプロセスを取得します。出力には、スクリプト ブロックを使用して計算されるプロパティ値が表示に表示されていないことが示されています。

パラメーター

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IncludeScriptBlock

フォーマット データ内のスクリプト ブロックをエクスポートするかどうかを示します。

スクリプト ブロックにはコードが含まれており、悪意を持って使用される可能性があるため、既定ではエクスポートされません。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

エクスポートするデータ オブジェクトの書式を指定します。 オブジェクトを含む変数、またはオブジェクトを取得するコマンド (Get-FormatData コマンドなど) を入力します。 Get-FormatData から Export-FormatDataにオブジェクトをパイプすることもできます。

型:	ExtendedTypeDefinition[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-LiteralPath

出力ファイルの場所を指定します。 Path パラメーターとは異なり、LiteralPath の値は、型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。

型:	String
Aliases:	PSPath, LP
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoClobber

コマンドレットが既存のファイルを上書きしないことを示します。 既定では、Export-FormatData は、ファイルに読み取り専用属性がない限り、警告なしでファイルを上書きします。

Export-FormatData に読み取り専用ファイルの上書きを指示するには、Force パラメーターを使用します。

型:	SwitchParameter
Aliases:	NoOverwrite
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Path

出力ファイルの場所を指定します。 format.ps1xml ファイル名拡張子を持つパス (省略可能) とファイル名を入力します。 パスを省略すると、Export-FormatData は現在のディレクトリにファイルを作成します。

.ps1xml 以外のファイル名拡張子を使用する場合、Update-FormatData コマンドレットはファイルを認識しません。

既存のファイルを指定した場合、Export-FormatData は、ファイルに読み取り専用属性がない限り、警告なしでファイルを上書きします。 読み取り専用ファイルを上書きするには、Force パラメーターを使用します。 ファイルが上書きされないようにするには、NoClobber パラメーターを使用します。

型:	String
Aliases:	FilePath
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

ExtendedTypeDefinition

ExtendedTypeDefinition オブジェクト パイプを から に渡すことができます。

出力

None

Export-FormatData はオブジェクトを返しません。 ファイルが生成され、指定したパスに保存されます。

メモ

• エクスポートされた書式設定ファイルを含む書式設定ファイルを使用するには、セッションの実行ポリシーでスクリプトと構成ファイルの実行を許可する必要があります。 詳細については、about_Execution_Policiesを参照してください。

関連リンク

• Get-FormatData
• Update-FormatData