Tee-Object (Microsoft.PowerShell.Utility)

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 перенаправляет вывод, то есть отправляет вывод команды в двух направлениях (например, буква Т). Он сохраняет выходные данные в файле или переменной, а также отправляет их по конвейеру. Если 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 выбирает свойства 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 для рекурсивного поиска системных файлов на диске D:. Оператор конвейера (|) отправляет список в Tee-Object, который добавляет список в файл AllSystemFiles.txt и передает список по конвейеру в Командлет Out-File, который сохраняет список в файле NewSystemFiles.txt.

Пример 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 фильтрует файлы, получая их содержимое в виде одной строки с помощью параметра Raw Get-Content и сравнивая эту строку с . >$frontMatterPattern.

Наконец, в примере печатаются имена файлов в папке, которые имеют определенный блок метаданных вступительной части.

Параметры

-Append

Указывает, что командлет добавляет выходные данные в указанный файл. Без этого параметра новое содержимое заменяет любое существующее содержимое файла без предупреждения.

Этот параметр был введен в Windows PowerShell 3.0.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: 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: кодирует в формате UTF-8 без метки порядка байтов (BOM).
utf32: кодирует в формате UTF-32.

Начиная с PowerShell 6.2, параметр Encoding также позволяет использовать числовые идентификаторы зарегистрированных кодовых страниц (например, -Encoding 1251) или строковые имена зарегистрированных кодовых страниц (например, -Encoding). "windows-1251"). Дополнительные сведения см. в документации .NET для Encoding.CodePage.

Начиная с PowerShell 7.4, вы можете использовать значение Ansi для параметра Encoding, чтобы передать числовой идентификатор для текущей кодовой страницы ANSI языка и региональных параметров без необходимости указывать его вручную.

Этот параметр был введен в PowerShell 7.2.

Примечание

UTF-7* больше не рекомендуется использовать. Начиная с PowerShell 7.1, при указании utf7 для параметра Кодировка выводится предупреждение.

Тип :: Кодирование
Принятые значения:: ASCII, BigEndianUnicode, OEM, Юникод, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Позиция:: 1
Значение по умолчанию:: UTF8NoBOM
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-FilePath

Указывает файл, в котором этот командлет сохраняет объект. Подстановочные знаки разрешены, но должны разрешаться в один файл.

Начиная с PowerShell 7, когда вы указываете FilePath как \\.\CON в Windows или /dev/tty в системах, отличных от Windows, InputObject печатается в консоли. Эти пути к файлам соответствуют текущему консольному устройству терминала в системе, что позволяет вам распечатать InputObject и отправить его в выходной поток с помощью одной команды.

Тип :: String
Псевдонимы:: Path
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: True

-InputObject

Указывает объект, который необходимо сохранить и отобразить. Введите переменную, содержащую объекты, или введите команду или выражение, позволяющее получить объекты. Вы также можете передать объект в Tee-Object.

Когда вы используете параметр InputObject с Tee-Object, вместо передачи результатов команды по конвейеру в Tee-Object, InputObject > значение рассматривается как один объект, даже если значение представляет собой коллекцию.

Тип :: PSОбъект
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-LiteralPath

Указывает файл, в котором этот командлет сохраняет объект. В отличие от FilePath, значение параметра LiteralPath используется точно так, как оно введено. Никакие символы не интерпретируются как подстановочные знаки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки сообщают PowerShell не интерпретировать никакие символы как escape-последовательности.

Тип :: String
Псевдонимы:: PSPath, LP
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Variable

Указывает переменную, в которой командлет сохраняет объект. Введите имя переменной без предшествующего знака доллара ($).

Тип :: String
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

PSObject

Вы можете передавать объекты в этот командлет.

Выходы

PSObject

Этот командлет возвращает объект, который он перенаправляет.

Примечания

PowerShell включает следующие псевдонимы для Tee-Object:

Windows:

Вы также можете использовать командлет Out-File или оператор перенаправления, оба из которых сохраняют выходные данные в файл, но не отправляют их по конвейеру.

Начиная с PowerShell 6, Tee-Object использует кодировку UTF-8 без спецификации при записи в файлы. Если вам нужна другая кодировка, используйте командлет Out-File с параметром Encoding.