Tee-Object

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

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

構文

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

説明

コマンドレットは Tee-Object 出力をリダイレクトします。つまり、コマンドの出力を 2 方向 (文字 T など) で送信します。 出力は、ファイルまたは変数に保存され、パイプラインにも送信されます。 パイプラインの最後のコマンドの場合 Tee-Object は、プロンプトにコマンド出力が表示されます。

例

例 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-ObjectAllSystemFiles.txt ファイルに追加するリストを送信し、そのリストをコマンドレットに Out-File 渡します。これにより、リストが保存されます NewSystemFiles.txt file。

例 4: 出力をコンソールに出力し、パイプラインで使用する

この例では、フォルダー内のファイルを取得し、コンソールに出力してから、フロント マター メタデータ ブロックが定義されているファイルをフィルター処理します。 最後に、フロントマターを持つ記事の名前を一覧表示します。

$consoleDevice = if ($IsWindows) {
    '\\.\CON'
} else {
    '/dev/tty'
}
$frontMatterPattern = '(?s)^---(?<FrontMatter>.+)---'

$articles = Get-ChildItem -Path .\reference\7.4\PSReadLine\About\ |
    Tee-Object -FilePath $consoleDevice |
    Where-Object {
        (Get-Content $_ -Raw) -match $frontMatterPattern
    }

$articles.Name

Directory: C:\code\docs\PowerShell-Docs\reference\7.4\PSReadLine\About

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---          12/13/2022 11:37 AM            384 .markdownlint.yaml
-a---           4/25/2023 11:28 AM          40194 about_PSReadLine_Functions.md
-a---           4/25/2023 10:58 AM          10064 about_PSReadLine.md

about_PSReadLine_Functions.md
about_PSReadLine.md

この例では、現在の $consoleDevice ターミナルのコンソール デバイスの値に変数を設定します。 Windows では、出力をファイルパスにリダイレクトすることで、現在のコンソール デバイスに \\.\CON 書き込むことができます。 Windows 以外のシステムでは、ファイルパスを使用します /dev/tty 。

次に、文字列が $frontMatterPattern 3 つのダッシュ (---) で始まり、別の 3 つのダッシュの前にコンテンツがある場合に一致する正規表現に変数を設定します。 このパターンがアーティクルのコンテンツと一致する場合、アーティクルには定義されたフロント マター メタデータ ブロックがあります。

次に、この例では、フォルダー内のすべてのファイルをAbout取得するために使用Get-ChildItemします。 Tee-Objectは、FileName パラメーターを使用してパイプされた結果をコンソールに出力します。 Where-Objectの Raw パラメーターを使用してコンテンツを 1 つの文字列として取得し、その文字列と比較することで、ファイルを$frontMatterPatternフィルター処理します。Get-Content

最後に、フロント マター メタデータ ブロックが定義されているフォルダー内のファイルの名前を出力します。

パラメーター

-Append

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

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

ターゲット ファイルのエンコードの種類を指定します。 既定値は utf8NoBOM です。

このパラメーターに使用できる値は次のとおりです。

  • ascii: ASCII (7 ビット) 文字セットのエンコードを使用します。
  • bigendianunicode: ビッグ エンディアンバイト順を使用して UTF-16 形式でエンコードします。
  • oem: MS-DOS およびコンソール プログラムの既定のエンコードを使用します。
  • unicode: リトル エンディアンバイト順を使用して UTF-16 形式でエンコードします。
  • utf7: UTF-7 形式でエンコードします。
  • utf8: UTF-8 形式でエンコードします。
  • utf8BOM: バイト オーダー マーク (BOM) を使用して UTF-8 形式でエンコードします。
  • utf8NoBOM: バイト オーダー マーク (BOM) を使用せずに UTF-8 形式でエンコードします。
  • utf32: UTF-32 形式でエンコードします。

PowerShell 6.2 以降では、Encoding パラメーターを使用すると、登録済みコード ページの数値 ID (いいね) -Encoding 1251や登録済みコード ページの文字列名 (例-Encoding "windows-1251") も使用できます。 詳細については、Encoding.CodePage の .NET ドキュメントを 参照してください。

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

Note

UTF-7* の使用は推奨されなくなりました。 PowerShell 7.1 の時点で、Encoding パラメーターに指定utf7すると警告が書き込まれます。

Type:Encoding
Accepted values:ASCII, BigEndianUnicode, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:1
Default value:UTF8NoBOM
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FilePath

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

PowerShell 7 以降では、Windows または /dev/tty Windows 以外のシステムで FilePath を\\.\CON指定すると、InputObject がコンソールに出力されます。 これらのファイル パスは、システム上の現在のターミナルのコンソール デバイスに対応しているため、InputObject を出力し、1 つのコマンドで出力ストリームに送信できます。

Type:String
Aliases:Path
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-InputObject

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

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

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

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

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Variable

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

入力

PSObject

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

出力

PSObject

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

メモ

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

  • Windows:
    • tee

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

PowerShell 6 以降では、 Tee-Object ファイルに書き込むときに BOM レス UTF-8 エンコードを使用します。 別のエンコードが必要な場合は、Encoding パラメーターを指定してOut-Fileコマンドレットを使用します。