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 cmdlet 将输出发送到文件。 它隐式使用 PowerShell 的格式设置系统写入文件。 该文件接收与终端相同的显示表示形式。 这意味着输出可能不适合编程处理，除非所有输入对象都是字符串。

使用重定向运算符（>）重定向 PowerShell 命令（cmdlet、函数、脚本）的输出，在功能上等效于通过没有额外参数的管道传送到 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 cmdlet 获取在本地计算机上运行的进程的列表。 进程 对象将管道发送到 Out-File cmdlet。 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 cmdlet 获取在本地计算机上运行的进程的列表。 进程 对象将管道发送到 Out-File cmdlet。 Out-File 使用 FilePath 参数，并尝试写入名为 Process.txt的当前目录中的文件。 NoClobber 参数可防止覆盖该文件，并显示一条消息，指出该文件已存在。

此示例演示如何使用特定编码类型对输出进行编码。

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

Get-Process cmdlet 获取在本地计算机上运行的进程的列表。 Process 对象存储在变量 $Procs中。 Out-File 使用 FilePath 参数，并在名为 Process.txt的当前目录中创建一个文件。 InputObject 参数将 $Procs 中的进程对象传递给文件 Process.txt。 编码 参数将输出转换为 ASCII 格式。 Width 参数将文件中的每一行限制为 50 个字符，以便可能会截断某些数据。

此示例演示如何在 Out-File 提供程序驱动器中时使用 cmdlet。 使用 Get-PSProvider cmdlet 查看本地计算机上的提供程序。 有关详细信息，请参阅 about_Providers。

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 命令使用 Path 参数将当前位置设置为注册表提供程序 Alias:。 Get-Location cmdlet 显示 Alias:的完整路径。 Get-ChildItem 将管道中的对象发送到 Out-File cmdlet。 Out-File 使用 FilePath 参数指定输出的完整路径和文件名，C:\TestDir\AliasNames.txt。 Get-Content cmdlet 使用 Path 参数，并在 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。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

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

此 cmdlet 不返回任何输出。

输入对象在终端中自动设置格式，但你可以使用 Format-* cmdlet 显式控制输出到文件的格式。 例如： Get-Date | Format-List | Out-File out.txt

若要将 PowerShell 命令的输出发送到 Out-File cmdlet，请使用管道。 或者，可以将数据存储在变量中，并使用 InputObject 参数将数据传递给 Out-File cmdlet。

Out-File 将数据保存到文件中，但它不会向管道生成任何输出对象。

PowerShell 7.2 添加了控制 ANSI 转义序列呈现方式的功能。 根据 Out-File 属性的设置，可以更改传递给 $PSStyle.OutputRendering 的 ANSI 修饰输出。 有关详细信息，请参阅 about_ANSI_Terminals。