Tee-Object
将命令输出保存在文件或变量中,并将其发送到管道。
语法
File (默认值)
Tee-Object
    [-FilePath] <String>
    [[-Encoding] <Encoding>]
    [-InputObject <PSObject>]
    [-Append]
    [<CommonParameters>]
		LiteralFile
	 
	Tee-Object
    [[-Encoding] <Encoding>]
    -LiteralPath <String>
    [-InputObject <PSObject>]
    [<CommonParameters>]
Variable
Tee-Object
    -Variable <String>
    [-InputObject <PSObject>]
    [<CommonParameters>]
说明
cmdlet Tee-Object 以两个方向写入输出。 它将输出存储在文件或变量中,并将其发送到管道。 如果 Tee-Object 管道中的最后一个命令,则命令输出将显示在控制台中。
在内部, Tee-Object 使用 Set-Variable 和 Out-File 命令。 这些命令支持 WhatIf 参数。 该 Tee-Object 命令不支持 WhatIf 参数。 但是,如果包装 Tee-Object 在支持 WhatIf 参数的脚本或函数中, Tee-Object 请将 WhatIf 的状态传递给 Set-Variable 命令 Out-File 。
示例
示例 1:将进程输出到文件和控制台
此示例获取计算机上运行的进程列表,并将结果发送到文件。 由于未指定第二个路径,因此进程也会显示在控制台中。
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 cmdlet 选择 ProcessName,并 句柄 属性。 请注意,$proc 变量包括 Get-Process返回的默认信息。
示例 3:将系统文件输出到两个日志文件
本示例将系统文件的列表保存在两个日志文件中,一个累积文件和一个当前文件。
Get-ChildItem -Path D: -File -System -Recurse |
  Tee-Object -FilePath "C:\test\AllSystemFiles.txt" -Append |
    Out-File C:\test\NewSystemFiles.txt
该命令使用 Get-ChildItem cmdlet 对 D: 驱动器上的系统文件执行递归搜索。 管道运算符(|)将列表发送到 Tee-Object,该列表将列表追加到 AllSystemFiles.txt 文件中,并将该列表向下传递到 Out-File cmdlet,该 cmdlet 将列表保存在 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 变量设置为正则表达式,该正则表达式在字符串以三条短划线(---)开头时匹配,并在另外三条短划线之前包含任何内容。 当此模式与项目内容匹配时,该文章具有定义的前端元数据块。
接下来,该示例使用 Get-ChildItem 检索 About 文件夹中的每一个文件。 
              Tee-Object 使用 FileName 参数将管道结果打印到控制台。 
              Where-Object 通过使用  的 Get-Content 参数获取其内容并将其内容与 $frontMatterPattern进行比较来筛选文件。
最后,该示例打印文件夹中具有定义的前端元数据块的文件的名称。
示例 5:在包含 WhatIf 参数的脚本中使用“Tee-Object” 
	该 Tee-Object 命令不支持 WhatIf 参数。 但是,如果包装Tee-Object在支持 WhatIf 参数的脚本或函数中,Tee-Object请将 WhatIf 的状态传递给Set-VariableOut-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
指示 cmdlet 将输出追加到指定的文件中。 如果没有此参数,新内容将替换文件中的任何现有内容,而不会发出警告。
此参数是在 Windows PowerShell 3.0 中引入的。
参数属性
| 类型: | SwitchParameter | 
| 默认值: | False | 
| 支持通配符: | False | 
| 不显示: | False | 
参数集
File
| Position: | Named | 
| 必需: | False | 
| 来自管道的值: | False | 
| 来自管道的值(按属性名称): | False | 
| 来自剩余参数的值: | False | 
-Encoding
指定目标文件的编码类型。 默认值是 utf8NoBOM。
此参数的可接受值如下所示:
- 
              ascii:对 ASCII(7 位)字符集使用编码。
- 
              ansi:对当前区域性的 ANSI 代码页使用编码。 此选项已在 PowerShell 7.4 中添加。
- 
              bigendianunicode:使用大端字节序以 UTF-16 格式进行编码。
- 
              oem:对 MS-DOS 和控制台程序使用默认编码。
- 
              unicode:使用小端字节序以 UTF-16 格式进行编码。
- 
              utf7:采用 UTF-7 格式编码。
- 
              utf8:采用 UTF-8 格式编码。
- 
              utf8BOM:以 UTF-8 格式编码并附加字节顺序标记(BOM)
- 
              utf8NoBOM:采用不带字节顺序标记(BOM)的 UTF-8 格式进行编码。
- 
              utf32:采用 UTF-32 格式编码。
从 PowerShell 6.2 开始,编码参数 还允许使用注册代码页的数字 ID(如 -Encoding 1251)或注册代码页的字符串名称(如 -Encoding "windows-1251")。 有关详细信息,请参阅 Encoding.CodePage.NET 文档。
从 PowerShell 7.4 开始,可以使用 Ansi 参数的  值来传递当前区域性 ANSI 代码页的数字 ID,而无需手动指定它。
此参数是在 PowerShell 7.2 中引入的。
注释
              UTF-7* 不再推荐使用。 从 PowerShell 7.1 起,如果为 utf7 参数指定 ,则会编写警告。
参数属性
| 类型: | Encoding | 
| 默认值: | UTF8NoBOM | 
| 接受的值: | ASCII, BigEndianUnicode, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32 | 
| 支持通配符: | False | 
| 不显示: | False | 
参数集
(All)
| Position: | 1 | 
| 必需: | False | 
| 来自管道的值: | False | 
| 来自管道的值(按属性名称): | False | 
| 来自剩余参数的值: | False | 
-FilePath 
		指定允许此 cmdlet 将对象保存到通配符的文件,但必须解析为单个文件。
从 PowerShell 7 开始,将 FilePath 指定为 Windows 上的 \\.\CON 或非 Windows 系统上的 /dev/tty 时,InputObject 将打印在控制台中。 这些文件路径对应于系统上当前终端的控制台设备,使你能够打印 InputObject 并使用一个命令将其发送到输出流。
参数属性
| 类型: | String | 
| 默认值: | None | 
| 支持通配符: | True | 
| 不显示: | False | 
| 别名: | 路径 | 
参数集
File
| Position: | 0 | 
| 必需: | True | 
| 来自管道的值: | False | 
| 来自管道的值(按属性名称): | False | 
| 来自剩余参数的值: | False | 
-InputObject 
		指定要保存和显示的对象。 输入一个包含对象的变量,或键入一个获取对象的命令或表达式。 还可以通过管道将对象传递给 Tee-Object。
将 InputObject 参数用于 Tee-Object时,即使该值为集合,Tee-Object 值也会被视为单个对象,而不是将命令结果 。
参数属性
| 类型: | PSObject | 
| 默认值: | None | 
| 支持通配符: | False | 
| 不显示: | False | 
参数集
(All)
| Position: | Named | 
| 必需: | False | 
| 来自管道的值: | True | 
| 来自管道的值(按属性名称): | False | 
| 来自剩余参数的值: | False | 
-LiteralPath 
		指定此 cmdlet 将对象保存到的文件。 与 FilePath不同,LiteralPath 参数的值被按其键入的形式使用。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
参数属性
| 类型: | String | 
| 默认值: | None | 
| 支持通配符: | False | 
| 不显示: | False | 
| 别名: | PSPath, LP | 
参数集
					LiteralFile 
					
				 
				| Position: | Named | 
| 必需: | True | 
| 来自管道的值: | False | 
| 来自管道的值(按属性名称): | False | 
| 来自剩余参数的值: | False | 
-Variable
指定 cmdlet 将对象保存到的变量。 输入没有上述美元符号的变量名称($)。
参数属性
| 类型: | String | 
| 默认值: | None | 
| 支持通配符: | False | 
| 不显示: | False | 
参数集
Variable
| Position: | Named | 
| 必需: | True | 
| 来自管道的值: | False | 
| 来自管道的值(按属性名称): | False | 
| 来自剩余参数的值: | False | 
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输入
PSObject
可以通过管道将对象传递给此 cmdlet。
输出
PSObject
此 cmdlet 返回它重定向的对象。
备注
PowerShell 包含以下与 Tee-Object相关的别名:
- 窗户:- tee
 
还可以使用 Out-File cmdlet 或重定向运算符,这两者都在文件中保存输出,但不将其发送到管道。
从 PowerShell 6 开始,Tee-Object 写入文件时使用无 BOM UTF-8 编码。 如果需要其他编码,请使用 Out-File cmdlet 和 Encoding 参数。