Out-File

Out-File
    [-FilePath] <string>
    [[-Encoding] <Encoding>]
    [-Append]
    [-Force]
    [-NoClobber]
    [-Width <int>]
    [-NoNewline]
    [-InputObject <psobject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Out-File
    [[-Encoding] <Encoding>]
    -LiteralPath <string>
    [-Append]
    [-Force]
    [-NoClobber]
    [-Width <int>]
    [-NoNewline]
    [-InputObject <psobject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Командлет Out-File отправляет выходные данные в файл. Она неявно использует систему форматирования PowerShell для записи в файл. Файл получает то же отображаемое представление, что и терминал. Это означает, что выходные данные могут не быть идеальными для программной обработки, если только все входные объекты не являются строками.

Перенаправление выходных данных PowerShell (командлета, функции, скрипта) с помощью оператора перенаправления (>) функционально эквивалентно перенаправлению в Out-File без дополнительных параметров. PowerShell 7.4 изменил поведение оператора перенаправления при использовании для перенаправления stdout потока собственной команды. Дополнительные сведения о перенаправлении см. в about_Redirection.

В этом примере показано, как отправить список процессов локального компьютера в файл. Если файл не существует, Out-File создает файл в указанном пути.

Get-Process | Out-File -FilePath .\Process.txt
Get-Content -Path .\Process.txt

 NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     29    22.39      35.40      10.98   42764   9 Application
     53    99.04     113.96       0.00   32664   0 CcmExec
     27    96.62     112.43     113.00   17720   9 Code

Командлет Get-Process получает список процессов, выполняемых на локальном компьютере. Объекты process отправляются в конвейер в командлет Out-File. Out-File использует параметр FilePath и создает файл в текущем каталоге с именем Process.txt. Команда Get-Content получает содержимое из файла и отображает его в консоли PowerShell.

Этот пример предотвращает перезапись существующего файла. По умолчанию Out-File перезаписывает существующие файлы.

Get-Process | Out-File -FilePath .\Process.txt -NoClobber

Out-File : The file 'C:\Test\Process.txt' already exists.
At line:1 char:15
+ Get-Process | Out-File -FilePath .\Process.txt -NoClobber
+               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Командлет Get-Process получает список процессов, выполняемых на локальном компьютере. Объекты process отправляются в конвейер в командлет Out-File. Out-File использует параметр FilePath и пытается записать в файл в текущем каталоге с именем Process.txt. Параметр NoClobber запрещает перезаписывать файл и отображает сообщение о том, что файл уже существует.

В этом примере показано, как кодировать выходные данные с определенным типом кодирования.

$Procs = Get-Process
Out-File -FilePath .\Process.txt -InputObject $Procs -Encoding ascii -Width 50

Командлет Get-Process получает список процессов, выполняемых на локальном компьютере. Объекты процесса хранятся в переменной $Procs. Out-File использует параметр FilePath и создает файл в текущем каталоге с именем Process.txt. Параметр inputObject передает объекты процесса в $Procs в файл Process.txt. Параметр кодировки преобразует выходные данные в формат ASCII. Параметр Width ограничивает каждую строку в файле до 50 символов, чтобы некоторые данные могли быть усечены.

В этом примере показано, как использовать командлет Out-File, если вы не используете диск поставщика FileSystem. Используйте командлет Get-PSProvider для просмотра поставщиков на локальном компьютере. Дополнительные сведения см. в разделе о поставщиках.

PS> Set-Location -Path Alias:

PS> Get-Location

Path
----
Alias:\

PS> Get-ChildItem | Out-File -FilePath C:\TestDir\AliasNames.txt

PS> Get-Content -Path C:\TestDir\AliasNames.txt

CommandType     Name
-----------     ----
Alias           % -> ForEach-Object
Alias           ? -> Where-Object
Alias           ac -> Add-Content
Alias           cat -> Get-Content

Команда Set-Location использует параметр пути, чтобы задать текущее расположение поставщику реестра Alias:. Командлет Get-Location отображает полный путь для Alias:. Get-ChildItem отправляет объекты вниз конвейера в командлет Out-File. Out-File использует параметр FilePath, чтобы указать полный путь и имя файла для выходных данных, C:\TestDir\AliasNames.txt. Командлет Get-Content использует параметр пути и отображает содержимое файла в консоли PowerShell.

В этом примере используется $PSDefaultParameterValues, чтобы задать параметр Width для всех вызовов Out-File и операторов перенаправления (> и >>) значение 2000. Это гарантирует, что везде в текущей области, в которую вы выводите форматированные данные таблицы в файл, PowerShell использует ширину строки 2000 вместо ширины строки, определенной шириной консоли узла PowerShell.

function DemoDefaultOutFileWidth() {
    try {
        $PSDefaultParameterValues['Out-File:Width'] = 2000

        $logFile = "$PWD\logfile.txt"

        Get-ChildItem Env:\ > $logFile

        Get-Service -ErrorAction Ignore |
            Format-Table -AutoSize |
            Out-File $logFile -Append

        Get-Process | Format-Table Id,SI,Name,Path,MainWindowTitle >> $logFile
    }
    finally {
        $PSDefaultParameterValues.Remove('Out-File:Width')
    }
}

DemoDefaultOutFileWidth

Дополнительные сведения о $PSDefaultParameterValuesсм. в about_Preference_Variables.

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

Этот командлет не возвращает выходные данные.

Входные объекты автоматически форматируются так, как они будут находиться в терминале, но можно использовать командлет Format-* для явного управления форматированием выходных данных в файле. Например: Get-Date | Format-List | Out-File out.txt

Чтобы отправить выходные данные команды PowerShell в командлет Out-File, используйте конвейер. Кроме того, можно хранить данные в переменной и использовать параметр InputObject для передачи данных командлету Out-File.

Out-File сохраняет данные в файл, но не создает выходные объекты в конвейере.

PowerShell 7.2 добавила возможность управлять отображением escape-последовательностей ANSI. Выходные данные, украшенные ANSI, передаваемые в Out-File, можно изменить на основе параметра свойства $PSStyle.OutputRendering. Дополнительные сведения см. в разделе about_ANSI_Terminals.