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-FormatDataIncludeScriptBlock パラメーターを使用して、ファイル内のフォーマット データにスクリプト ブロックを含めます。

例 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 番目のコマンドでは、 コマンドレットの InputObject パラメーターを Export-FormatData 使用して、変数に保存された書式データを $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

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

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

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

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

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

パラメーター

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

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

-IncludeScriptBlock

形式データのスクリプト ブロックがエクスポートされるかどうかを示します。

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

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

-InputObject

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

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

-LiteralPath

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

Type:	String
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoClobber

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

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

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

-Path

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

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

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

Type:	String
Aliases:	FilePath
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

入力

ExtendedTypeDefinition

ExtendedTypeDefinition オブジェクトをからGet-FormatDataこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。 ファイルを生成し、指定されたパス内に保存します。

メモ

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

関連リンク

• Get-FormatData
• Update-FormatData