PowerShell Cmdlet - Add-History
 記事記号:[mf1905] 初版:2011/Sep/30

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

名前
    Add-History
    
概要
    エントリをセッション履歴に追加します。
    
構文
    Add-History [[-InputObject] <PSObject[]>] [-PassThru] [<CommonParameters>]    
    
説明
    Add-History コマンドレットは、エントリをセッションの末尾に追加します。セッシ
    ョン履歴とは、現在のセッション中に入力されたコマンドの一覧です。
    
    Get-History コマンドレットを使用すると、コマンドを取得して Add-History に渡す
    ことができます。または、コマンドを CSV ファイルまたは XML ファイルにエクスポ
    ートした後、そのコマンドをインポートし、インポートしたファイルを Add-History 
    に渡すことができます。Add-History コマンドレットを使用すると、特定のコマンド
    を履歴に追加したり、複数のセッションのコマンドを含む単一の履歴ファイルを作成
    したりすることができます。
    
パラメーター
    -InputObject 
        指定された HistoryInfo オブジェクトをセッション履歴に追加します。このパラ
        メーターを使用すると、Get-History、Import-Clixml、または Import-Csv の H
        istoryInfo オブジェクトを Add-History に渡すことができます。
        
        必須                         false
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByValue)
        ワイルドカード文字を許可する false
        
    -PassThru []
        各履歴エントリに対して履歴オブジェクトを返します。既定では、このコマンド
        レットによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    Microsoft.PowerShell.Commands.HistoryInfo
        パイプを使用して Add-History に HistoryInfo オブジェクトを渡すことができ
        ます。
    
出力
    None または Microsoft.PowerShell.Commands.HistoryInfo
        Add-History で PassThru パラメーターを使用すると、HistoryInfo オブジェク
        トが生成されます。それ以外の場合、このコマンドレットによる出力はありませ
        ん。
    
メモ
        セッション履歴は、セッション中に入力されたコマンドと ID の一覧です。セッ
        ション履歴は、コマンドの実行順序、状態、および開始時刻と終了時刻を表しま
        す。コマンドを入力するたびに、そのコマンドは Windows PowerShell によって
        履歴に追加され、再利用できるようになります。セッション履歴の詳細について
        は、「about_History」を参照してください。
        
        履歴に追加するコマンドを指定するには、InputObject パラメーターを使用しま
        す。Add-History コマンドが受け入れるのは、HistoryInfo オブジェクト (各コ
        マンドの Get-History によって生成された HistoryInfo オブジェクトなど) の
        みです。パスとファイル名を渡すことも、コマンドの一覧を渡すこともできませ
        ん。
        
        -InputObject パラメーターを使用すると、Add-History に HistoryInfo オブジ
        ェクトのファイルを渡すことができます。そのためには、Export-Csv または Ex
        port-Clixml を使用して Get-History コマンドの結果をファイルにエクスポート
        し、そのファイルを Import-Csv または Import-Clixml を使用してインポートし
        ます。インポートした HistoryInfo オブジェクトのファイルは、パイプラインを
        介して、または変数として Add-History に渡すことができます。詳細について
        は、例を参照してください。
        
        Add-History に渡す HistoryInfo オブジェクトのファイルには、HistoryInfo オ
        ブジェクトの型の情報、列見出し、およびすべてのプロパティが含まれている必
        要があります。オブジェクトを Add-History に戻す場合は、Export-Csv の NoTy
        peInformation パラメーターを使用しないでください。また、ファイル内の型の
        情報、列見出し、その他のフィールドは削除しないでください。
        
        セッション履歴を編集するには、セッションを CSV ファイルまたは XML ファイ
        ルにエクスポートし、そのファイルを編集します。次に、そのファイルをインポ
        ートし、Add-History を使用して現在のセッション履歴に追加します。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>get-history | export-csv c:\testing\history.csv
    
    C:\PS>import-csv history.csv | add-history
    
    説明
    -----------
    これらのコマンドは、ある Windows PowerShell セッション中に入力されたコマンド
    を別の Windows PowerShell セッションの履歴に追加します。最初のコマンドは、履
    歴内のコマンドを表すオブジェクトを取得し、History.csv ファイルにエクスポート
    します。2 番目のコマンドは、別のセッションのコマンド ラインから入力されてい
    ます。このコマンドは、Import-Csv コマンドレットを使用して、History.csv ファ
    イルのオブジェクトをインポートします。パイプライン演算子によってオブジェクト
    が Add-History コマンドレットに渡され、その Add-History コマンドレットが His
    tory.csv ファイル内のコマンドを表すオブジェクトを現在のセッション履歴に追加
    します。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>import-clixml c:\temp\history.xml | add-history -passthru | foreach-ob
    ject {invoke-history}
    
    説明
    -----------
    このコマンドは、History.xml ファイル内のコマンドをインポートし、現在のセッシ
    ョン履歴に追加してから、結合された履歴内のそのインポートしたコマンドを実行し
    ます。
    
    最初のコマンドは、Import-Clixml コマンドを使用して、History.xml ファイルにエ
    クスポートされたコマンド履歴をインポートします。コマンドはパイプライン演算子 
    (|) によって Add-History のパラメーターに渡され、現在のセッション履歴に追加
    されます。PassThru パラメーターを指定すると、追加するコマンドを表すオブジェ
    クトが、パイプラインを介して渡されます。
    
    次にこのコマンドは、ForEach-Object コマンドレットを使用して、結合された履歴
    内の各コマンドに Invoke-History コマンドを適用します。Invoke-History コマン
    ドは、スクリプト ブロック形式 (中かっこ ( { } ) で囲まれた状態) で示されます。
    これは、適用するコマンドが 1 つしかない場合でも、ForEach-Object にはスクリプ
    ト ブロックが必要であるためです。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>get-history -id 5 -count 5 | add-history
    
    説明
    -----------
    このコマンドは、履歴の最初の 5 つのコマンドを履歴一覧の最後に追加します。Get
    -History コマンドレットを使用して、コマンド 5 を最後とする 5 つのコマンドを
    取得します。この 5 つのコマンドはパイプライン演算子 (|) によって Add-History
    コマンドレットに渡され、現在の履歴に追加されます。Add-History コマンドにはパ
    ラメーターがありませんが、パイプラインを介して渡されるオブジェクトが Windows 
    PowerShell により InputObject パラメーターと関連付けられます。
    
    -------------------------- 例 4 --------------------------
    
    C:\PS>$a = import-csv c:\testing\history.csv
    
    C:\PS>add-history -inputobject $a -passthru
    
    説明
    -----------
    これらのコマンドは、History.csv ファイル内のコマンドを現在のセッション履歴に
    追加します。最初のコマンドは、Import-Csv コマンドレットを使用して History.cs
    v ファイルにコマンドをインポートし、その内容を変数 $a に保存します。2 番目の
    コマンドは、Add-History コマンドレットを使用して、History.csv のコマンドを現
    在のセッション履歴に追加します。このコマンドは、InputObject パラメーターを使
    用して $a 変数と PassThru パラメーターを指定し、コマンド ラインに表示するオ
    ブジェクトを生成します。Add-History で PassThru パラメーターを指定していない
    場合、表示用の出力は生成されません。
    
    -------------------------- 例 5 --------------------------
    
    C:\PS>add-history -inputobject (import-clixml c:\temp\history01.xml)
    
    説明
    -----------
    このコマンドは、History01.xml ファイル内のコマンドを現在のセッション履歴に追
    加します。このコマンドは InputObject パラメーターを使用して、かっこ内のコマン
    ドの結果を Add-History に渡します。かっこ内のコマンドが最初に実行され、Histo
    ry01.xml ファイルが Windows PowerShell にインポートされます。次に、Add-Histo
    ry はファイルのコマンドをセッション履歴に追加します。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113279
    about_History 
    Get-History 
    Invoke-History 
    Clear-History 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Add-History
ご利用数: 1913973
感想・要望・問い合わせは こちら