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 cmdlet 将重定向输出，即它将沿两个方向发送命令的输出（类似字母 T）。 它将输出存储在文件或变量中，同时通过管道向下发送。 如果 Tee-Object 是管道中的最后一个命令，则命令输出将显示在提示符处。

示例

示例 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 和 Handles 属性。 请注意，$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，以将其保存在 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 的 Raw 参数获取单个字符串形式的文件内容，然后将该字符串与 $frontMatterPattern 进行比较。

最后，该示例输出文件夹中包含定义的前言元数据块的文件的名称。

参数

-Append

指示 cmdlet 将输出追加到指定的文件。 在没有此参数的情况下，新内容将替换文件中的所有现有内容，而不显示警告。

已在 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：使用 big-endian 字节顺序以 UTF-16 格式进行编码。
  • oem：对 MS-DOS 和控制台程序使用默认编码。
  • unicode：使用 little-endian 字节顺序以 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 中引入的。

注意

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

指定此 cmdlet 将对象保存到的文件。允许使用通配符，但必须解析为单个文件。

从 PowerShell 7 开始，在 Windows 上将 FilePath 指定为 \\.\CON 或者在非 Windows 系统上将其指定为 /dev/tty 时，控制台中会输出 InputObject。 这些文件路径对应于系统上当前终端的控制台设备，使你能够通过单个命令输出 InputObject 并将其发送到输出流。

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

-InputObject

指定要保存和显示的对象。 输入一个包含对象的变量，或键入可获取对象的命令或表达式。 也可以通过管道将对象传递给 Tee-Object。

将 InputObject 参数用于 Tee-Object 时，InputObject 值将被视为单个对象，而不是通过管道将命令结果传递给 Tee-Object，即使该值是集合。

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

-LiteralPath

指定此 cmdlet 将对象保存到的文件。 与 FilePath 不同，LiteralPath 参数的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包括转义符，请将其括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

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

-Variable

指定此 cmdlet 将对象保存到的变量。 输入一个不带前置美元符号 ($) 的变量名称。

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

输入

PSObject

可以通过管道将对象传递给此 cmdlet。

输出

PSObject

此 cmdlet 返回它重定向的对象。

备注

PowerShell 包含以下 Tee-Object 别名：

  • Windows：
    • tee

还可使用 Out-File cmdlet 或重定向运算符，它们都可以将输出保存在文件中，但不会通过管道发送输出。

从 PowerShell 6 开始，Tee-Object 在写入文件时使用无 BOM UTF-8 编码。 如果需要其他编码，请使用 Out-File cmdlet 及 Encoding 参数。