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

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

名前
    Update-FormatData
    
概要
    現在のセッションの書式設定データを更新します。
    
構文
    Update-FormatData [[-AppendPath] <string[]>] [-PrependPath <string[]>] [-Con
    firm] [-WhatIf] [<CommonParameters>]
    
説明
    Update-FormatData コマンドレットは、書式設定ファイルから書式設定データを現在
    のセッションに再度読み込みます。このコマンドレットを使用すると、Windows Powe
    rShell を再起動することなく、書式設定データを更新できます。
    
    パラメーターが指定されていない場合、Update-FormatData は、以前に読み込んだ書
    式設定ファイルを再度読み込みます。Update-FormatData のパラメーターを使用する
    と、新しい書式設定ファイルをセッションに追加できます。
    
    書式設定ファイルは、format.ps1xml ファイル名拡張子を持つ XML 形式のテキスト 
    ファイルです。ファイル内の書式設定データは、セッションでの Microsoft .NET Fr
    amework オブジェクトの表示を定義します。
    
    Windows PowerShell が起動されると、Windows PowerShell インストール ディレク
    トリ ($pshome) にある書式設定ファイルの書式データがセッションに読み込まれま
    す。Update-FormatData を使用すると、Windows PowerShell を再起動することなく、
    書式設定データを現在のセッションに再度読み込むことができます。この機能は、
    書式設定ファイルを追加または変更したときにセッションを中断したくない場合に
    便利です。
    
    Windows PowerShell の書式設定ファイルの詳細については、「about_Format.ps1xm
    l」を参照してください。
    
パラメーター
    -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
        
    -Confirm [<SwitchParameter>]
        コマンドを実行する前に確認メッセージを表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -WhatIf [<SwitchParameter>]
        実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help 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.ps1x
    ml) を含む書式設定ファイルをセッションに再度読み込みます。
    
    このコマンドでは 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 は、パラメーターを使用しないで、自動的に再読み込
    みを行います。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113420
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Update-FormatData
ご利用数: 1857558
感想・要望・問い合わせは こちら