Out-File

Syntax

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>]

Description

O Out-File cmdlet envia a saída para um ficheiro. Utiliza implicitamente o sistema de formatação do PowerShell para escrever no ficheiro. O ficheiro recebe a mesma representação de apresentação que o terminal. Isto significa que a saída pode não ser ideal para processamento programático, a menos que todos os objetos de entrada sejam cadeias. Quando precisar de especificar parâmetros para a saída, utilize Out-File em vez do operador de redirecionamento (>). Para obter mais informações sobre o redirecionamento, veja about_Redirection.

Exemplos

Exemplo 1: Enviar saída e criar um ficheiro

Este exemplo mostra como enviar uma lista dos processos do computador local para um ficheiro. Se o ficheiro não existir, Out-File cria o ficheiro no caminho especificado.

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

O Get-Process cmdlet obtém a lista de processos em execução no computador local. Os objetos Processo são enviados pelo pipeline para o Out-File cmdlet. Out-File utiliza o parâmetro FilePath e cria um ficheiro no diretório atual com o nome Process.txt. O Get-Content comando obtém conteúdo do ficheiro e apresenta-o na consola do PowerShell.

Exemplo 2: Impedir que um ficheiro existente seja substituído

Este exemplo impede que um ficheiro existente seja substituído. Por predefinição, Out-File substitui os ficheiros existentes.

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
+               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

O Get-Process cmdlet obtém a lista de processos em execução no computador local. Os objetos Processo são enviados pelo pipeline para o Out-File cmdlet. Out-File utiliza o parâmetro FilePath e tenta escrever num ficheiro no diretório atual com o nome Process.txt. O parâmetro NoClobber impede que o ficheiro seja substituído e apresenta uma mensagem a indicar que o ficheiro já existe.

Exemplo 3: Enviar saída para um ficheiro no formato ASCII

Este exemplo mostra como codificar a saída com um tipo de codificação específico.

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

O Get-Process cmdlet obtém a lista de processos em execução no computador local. Os objetos Processo são armazenados na variável . $Procs Out-File utiliza o parâmetro FilePath e cria um ficheiro no diretório atual com o nome Process.txt. O parâmetro InputObject transmite os objetos $Procs de processo para o ficheiro Process.txt. O parâmetro Codificação converte o resultado em formato ASCII . O parâmetro Width limita cada linha no ficheiro a 50 carateres para que alguns dados possam ser truncados.

Exemplo 4: utilizar um fornecedor e enviar a saída para um ficheiro

Este exemplo mostra como utilizar o Out-File cmdlet quando não está numa unidade de fornecedor fileSystem . Utilize o Get-PSProvider cmdlet para ver os fornecedores no seu computador local. Para obter mais informações, veja 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

O Set-Location comando utiliza o parâmetro Caminho para definir a localização atual para o fornecedor Alias:de registo . O Get-Location cmdlet apresenta o caminho completo para Alias:. Get-ChildItem envia objetos pelo pipeline para o Out-File cmdlet. Out-File utiliza o parâmetro FilePath para especificar o caminho completo e o nome do ficheiro para a saída ,C:\TestDir\AliasNames.txt. O Get-Content cmdlet utiliza o parâmetro Caminho e apresenta o conteúdo do ficheiro na consola do PowerShell.

Exemplo 5: definir a largura de saída do ficheiro para todo o âmbito

Este exemplo utiliza $PSDefaultParameterValues para definir o Width parâmetro para todas as invocações de e os operadores de Out-File redirecionamento (> e >>) para 2000. Isto garante que em qualquer parte do âmbito atual que produz dados formatados em tabela para ficheiro, o PowerShell utiliza uma largura de linha de 2000 em vez de uma largura de linha determinada pela largura da consola do anfitrião do 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

Para obter mais informações sobre $PSDefaultParameterValueso , consulte about_Preference_Variables.

Parâmetros

-Append

-Confirm

-Encoding

-FilePath

-Force

-InputObject

-LiteralPath

-NoClobber

-NoNewline

-WhatIf

-Width

Entradas

PSObject

Pode encaminhar qualquer objeto para este cmdlet.

Saídas

None

Este cmdlet não devolve nenhuma saída.

Notas

Os objetos de entrada são automaticamente formatados como estariam no terminal, mas pode utilizar um Format-* cmdlet para controlar explicitamente a formatação da saída para o ficheiro. Por exemplo, Get-Date | Format-List | Out-File out.txt

Para enviar a saída de um comando do PowerShell para o Out-File cmdlet, utilize o pipeline. Em alternativa, pode armazenar dados numa variável e utilizar o parâmetro InputObject para transmitir dados para o Out-File cmdlet.

Out-File guarda dados num ficheiro, mas não produz objetos de saída no pipeline.

O PowerShell 7.2 adicionou a capacidade de controlar a forma como as sequências de escape do ANSI são compostas. O resultado decorado com ANSI que é transmitido para Out-File pode ser alterado com base na definição da $PSStyle.OutputRendering propriedade. Para obter mais informações, veja about_ANSI_Terminals.

Ligações Relacionadas

• about_Providers
• about_Quoting_Rules
• Out-Default
• Out-Host
• Out-Null
• Out-String
• Tee-Object