Export-FormatData

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」を参照してください。

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

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

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

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

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

$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 パラメーターを使用して、$F 変数に保存された書式データを入力します。 また、IncludeScriptBlock パラメーターを使用して、スクリプト ブロックを出力に含めます。

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 パラメーターを省略した場合の効果を示します。

最初のコマンドでは、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 で始まる名前を持つプロセスを取得します。出力には、スクリプト ブロックを使用して計算されるプロパティ値が表示に表示されていないことが示されています。

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

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

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

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