PowerShell Cmdlet - Export-FormatData
 記事記号:[mf1947] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Export-FormatData
    
概要
    現在のセッションの書式設定データを書式設定ファイルに保存します。
    
構文
    Export-FormatData [-Force] [-IncludeScriptBlock] [-InputObject <ExtendedType
    Definition[]>] [-NoClobber] [-Path <string>] [<CommonParameters>]
    
    
説明
    Export-FormatData コマンドレットは、現在のセッションの書式設定オブジェクトか
    ら Windows PowerShell 書式設定ファイル (format.ps1xml) を作成します。Get-For
    matData が返す ExtendedTypeDefinition オブジェクトを受け取り、それを XML 形
    式でファイルに保存します。
    
    Windows PowerShell のセッションでは、書式設定ファイル (format.ps1xml) のデー
    タを使用して、Microsoft .NET Framework オブジェクトの既定の表示が生成されま
    す。書式設定ファイルは必要に応じて表示、編集したり、Update-FormatData コマン
    ドレットを使用して書式設定データをセッションに追加したりできます。
    
    Windows PowerShell の書式設定ファイルの詳細については、「about_Format.ps1xml
    」を参照してください。
    
パラメーター
    -Force [<SwitchParameter>]
        ファイルに読み取り専用属性が設定されている場合でも、既存の出力ファイルを
        上書きします。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -IncludeScriptBlock [<SwitchParameter>]
        書式データとしてスクリプト ブロックをエクスポートするかどうかを決定しま
        す。
        
        スクリプト ブロックにはコードが含まれており、悪用される可能性があること
        から、既定ではエクスポートされません。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -InputObject <ExtendedTypeDefinition[]>
        エクスポート対象の書式データ オブジェクトを指定します。オブジェクトを含
        んでいる変数か、オブジェクトを取得するコマンド (Get-FormatData コマンド
        など) を入力します。パイプを使用して Get-FormatData から Export-FormatDa
        ta にオブジェクトを渡すこともできます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByValue)
        ワイルドカード文字を許可する false
        
    -NoClobber [<SwitchParameter>]
        既存のファイルの上書きを防止します。既定では、ファイルに読み取り専用属性
        が設定されていない限り、Export-FormatData は、警告なしでファイルを上書き
        します。
        
        Export-FormatData で読み取り専用のファイルを強制的に上書きするには、Forc
        e パラメーターを使用します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Path <string>
        出力ファイルの場所を指定します。パス (オプション) とファイル名を、format
        .ps1xml というファイル名拡張子を付けて入力します。パスを省略した場合は、
        Export-FormatData によって、現在のディレクトリにファイルが作成されます。
        
        .ps1xml 以外のファイル名拡張子を使用した場合、Update-FormatData コマンド
        レットによってファイルが認識されません。
        
        既存のファイルが指定された場合、そのファイルに読み取り専用属性が設定され
        ていない限り、Export-FormatData は警告なしでファイルを上書きします。読み
        取り専用ファイルを上書きするには、Force パラメーターを使用します。ファイ
        ルの上書きを防止するには、NoClobber パラメーターを使用します。
        
        必須                         false
        位置                         named
        既定値                       なし
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.Management.Automation.ExtendedTypeDefinition
        パイプを使用して ExtendedTypeDefinition オブジェクトを Get-FormatData か
        ら Export-FormatData に渡すことができます。
    
出力
    なし
        Export-FormatData はオブジェクトを返しません。ファイルを生成し、指定され
        たパスに保存します。
    
メモ
        書式設定ファイル (エクスポートした書式設定ファイルを含む) を使用するには、
        セッションの実行ポリシーで、スクリプトと構成ファイルの実行が許可されてい
        る必要があります。詳細については、「about_Execution_Policies」を参照して
        ください。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>get-formatdata -typename * | export-formatdata -path allformat.ps1xml 
    -IncludeScriptBlock
    
    説明
    -----------
    このコマンドは、セッションのすべての書式データを AllFormat.ps1xml ファイルに
    エクスポートします。
    
    このコマンドは、Get-FormatData コマンドレットを使用して、セッションの書式デ
    ータを取得します。TypeName パラメーターの値にアスタリスク (*) を指定すると、
    セッションのすべてのデータが取得されます。
    
    このコマンドでは、書式データがパイプライン演算子 (|) で Get-FormatData コマ
    ンドから Export-FormatData コマンドレットに渡され、AllFormat.ps1 ファイルに
    エクスポートされます。
    
    Export-FormatData コマンドは、IncludeScriptBlock パラメーターを使用して、フ
    ァイル内の書式データにスクリプト ブロックを追加します。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>$f = get-formatdata -typename helpinfoshort
    
    C:\PS> export-formatdata -inputObject $f -path c:\test\help.format.ps1xml -I
    ncludeScriptBlock
    
    説明
    -----------
    これらのコマンドは、HelpInfoShort 型の書式データを Help.format.ps1xml ファイ
    ルにエクスポートします。
    
    最初のコマンドは Get-FormatData コマンドレットを使用して HelpInfoShort 型の書
    式データを取得し、それを $f 変数に保存します。
    
    2 番目のコマンドは、Export-FormatData の InputObject パラメーターを使用して、
    $f 変数に保存されている書式データを入力します。また、出力にスクリプト ブロッ
    クを含めるために、IncludeScriptBlock パラメーターが使用されています。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>get-formatdata -typename System.Diagnostics.Process | export-FormatData 
    -path process.format.ps1xml
    
    C:\PS> Update-FormatData -prependPath .\process.format.ps1xml
    
    C:\PS> 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-Process コマンドレットが返す System.Diagnostics.Proces
    s オブジェクトの書式データを、Get-FormatData コマンドレットを使用して取得し
    ます。書式設定データはパイプライン演算子 (|) で Export-FormatData コマンドレ
    ットに送られ、現在のディレクトリにある Process.format.ps1xml ファイルにエク
    スポートされます。
    
    この場合、Export-FormatData コマンドに、IncludeScriptBlock パラメーターは使
    用されていません。
    
    2 つ目のコマンドは、Update-FormatData コマンドレットを使用して、Process.forma
    t.ps1xml ファイルを現在のセッションに追加します。PrependPath パラメーターを使
    用して、Process.format.ps1xml ファイルにあるプロセス オブジェクトの書式設定デ
    ータが、プロセス オブジェクトの標準の書式設定データよりも先に見つかるようにし
    てします。
    
    3 番目のコマンドは、この変更による影響を示しています。Get-Process コマンドレ
    ットを使用して、名前が "P" で始まるプロセスを取得します。この出力を見ると、ス
    クリプト ブロックを使って計算されるプロパティ値が表示から欠落していることがわ
    かります。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=144302
    Get-FormatData 
    Update-FormatData 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Export-FormatData
ご利用数: 1975222
感想・要望・問い合わせは こちら