次の方法で共有


Tee-Object

コマンド出力をファイルまたは変数に保存し、パイプラインに送信します。

構文

File (既定)

Tee-Object
    [-FilePath] <String>
    [-InputObject <PSObject>]
    [-Append]
    [<CommonParameters>]

LiteralFile

Tee-Object
    -LiteralPath <String>
    [-InputObject <PSObject>]
    [<CommonParameters>]

Variable

Tee-Object
    -Variable <String>
    [-InputObject <PSObject>]
    [<CommonParameters>]

説明

Tee-Object コマンドレットは、2 方向に出力を書き込みます。 出力はファイルまたは変数に格納され、パイプラインにも送信されます。 Tee-Objectがパイプラインの最後のコマンドである場合、コマンド出力がコンソールに表示されます。

内部的には、 Tee-ObjectSet-Variable コマンドと Out-File コマンドを使用します。 これらのコマンドは 、WhatIf パラメーターをサポートします。 Tee-Object コマンドは WhatIf パラメーターをサポートしていません。 ただし、WhatIf パラメーターをサポートするスクリプトまたは関数でTee-Objectをラップした場合、Tee-ObjectWhatIf の状態を Set-Variable および Out-File コマンドに渡します。

例 1: 出力プロセスをファイルとコンソールに出力する

この例では、コンピューターで実行されているプロセスの一覧を取得し、結果をファイルに送信します。 2 番目のパスが指定されていないため、プロセスもコンソールに表示されます。

Get-Process | Tee-Object -FilePath "C:\Test1\testfile2.txt"
Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)    Id ProcessName
-------  ------    -----      ----- -----   ------    -- -----------
83       4     2300       4520    39     0.30    4032 00THotkey
272      6     1400       3944    34     0.06    3088 alg
81       3      804       3284    21     2.45     148 ApntEx
81       4     2008       5808    38     0.75    3684 Apoint
...

例 2: 変数と 'Select-Object' にプロセスを出力する

この例では、コンピューター上で実行されているプロセスの一覧を取得し、$proc 変数に保存し、それらをパイプして Select-Objectします。

Get-Process notepad | Tee-Object -Variable proc | Select-Object ProcessName, Handles
ProcessName                              Handles
-----------                              -------
notepad                                  43
notepad                                  37
notepad                                  38
notepad                                  38

Select-Object コマンドレットは、ProcessName プロパティと Handles プロパティを選択します。 $proc 変数には、Get-Processによって返される既定の情報が含まれていることに注意してください。

例 3: システム ファイルを 2 つのログ ファイルに出力する

次の使用例は、システム ファイルの一覧を、累積ファイルと現在のファイルの 2 つのログ ファイルに保存します。

Get-ChildItem -Path D: -File -System -Recurse |
  Tee-Object -FilePath "C:\test\AllSystemFiles.txt" -Append |
    Out-File C:\test\NewSystemFiles.txt

このコマンドでは、Get-ChildItem コマンドレットを使用して、D: ドライブ上のシステム ファイルを再帰的に検索します。 パイプライン演算子 (|) は、リストを Tee-Objectに送信します。これにより、リストが AllSystemFiles.txt ファイルに追加され、そのリストが Out-File コマンドレットに渡され、NewSystemFiles.txt fileにリストが保存されます。

例 4: **WhatIf** パラメーターを指定してスクリプトで 'Tee-Object' を使用する

Tee-Object コマンドは WhatIf パラメーターをサポートしていません。 ただし、WhatIf パラメーターをサポートするスクリプトまたは関数でTee-Objectをラップする場合、Tee-ObjectWhatIf の状態をSet-Variableに渡し、内部で使用するコマンドOut-Fileします。

PS> function Test-Tee {
    [Cmdletbinding(SupportsShouldProcess)]
    Param()
    $true|tee -Variable b
    "Variable `$b is set to '$b'"
}

PS> Test-Tee

True
Variable $b is set to 'True'

PS> Test-Tee -WhatIf
True
What if: Performing the operation "Set variable" on target "Name: b Value: True".
Variable $b is set to ''

パラメーター

-Append

コマンドレットが指定したファイルに出力を追加することを示します。 このパラメーターを指定しない場合、新しいコンテンツは警告なしでファイル内の既存のコンテンツを置き換えます。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

File
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-FilePath

このコマンドレットでオブジェクトをワイルドカード文字に保存するファイルを指定しますが、1 つのファイルに解決する必要があります。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:True
DontShow:False

パラメーター セット

File
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-InputObject

保存して表示するオブジェクトを指定します。 オブジェクトを含む変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。 オブジェクトを Tee-Object にパイプすることもできます。

InputObject パラメーターを Tee-Objectと共に使用すると、コマンドの結果を Tee-Objectにパイプするのではなく、値がコレクションであっても、InputObject 値は 1 つのオブジェクトとして扱われます。

パラメーターのプロパティ

型:PSObject
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-LiteralPath

このコマンドレットでオブジェクトを保存するファイルを指定します。 FilePathとは異なり、LiteralPath パラメーターの値は、型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:PSPath

パラメーター セット

LiteralFile
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Variable

コマンドレットがオブジェクトを保存する変数を指定します。 前のドル記号 ($) なしで変数名を入力します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Variable
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

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

入力

PSObject

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

出力

PSObject

このコマンドレットは、リダイレクトするオブジェクトを返します。

メモ

Windows PowerShell には、Tee-Objectの次のエイリアスが含まれています。

  • tee

また、Out-File コマンドレットまたはリダイレクト演算子を使用することもできます。どちらも出力をファイルに保存しますが、パイプラインには送信しません。

Tee-Object では、ファイルへの書き込み時に "Unicode" (UTF-16LE) エンコードが使用されます。 別のエンコードが必要な場合は、Out-File コマンドレットと Encoding パラメーターを使用します。