Compartilhar via

Out-File

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Envia a saída para um arquivo.

Syntax

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

Description

O Out-File cmdlet envia a saída para um arquivo. Quando você precisar especificar parâmetros para o uso Out-File de saída em vez do operador de redirecionamento (>).

Exemplos

Exemplo 1: Enviar saída e criar um arquivo

Este exemplo mostra como enviar uma lista dos processos do computador local para um arquivo. Se o arquivo não existir, Out-File o criará o arquivo 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 Process são enviados pelo pipeline para o Out-File cmdlet . Out-File usa o parâmetro FilePath e cria um arquivo no diretório atual chamado Process.txt. O Get-Content comando obtém o conteúdo do arquivo e o exibe no console do PowerShell.

Exemplo 2: impedir que um arquivo existente seja substituído

Este exemplo impede que um arquivo existente seja substituído. Por padrão, Out-File substitui os arquivos 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 Process são enviados pelo pipeline para o Out-File cmdlet . Out-File usa o parâmetro FilePath e tenta gravar em um arquivo no diretório atual chamado Process.txt. O parâmetro NoClobber impede que o arquivo seja substituído e exibe uma mensagem informando que o arquivo já existe.

Exemplo 3: Enviar saída para um arquivo 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 Process são armazenados na variável , $Procs. Out-File usa o parâmetro FilePath e cria um arquivo no diretório atual chamado Process.txt. O parâmetro InputObject passa os objetos $Procs de processo para o arquivo Process.txt. O parâmetro Encoding converte a saída em formato ASCII . O parâmetro Width limita cada linha do arquivo a 50 caracteres para que alguns dados possam ser truncados.

Exemplo 4: usar um provedor e enviar a saída para um arquivo

Este exemplo mostra como usar o Out-File cmdlet quando você não está em uma unidade do provedor FileSystem . Use o Get-PSProvider cmdlet para exibir os provedores no computador local. Para obter mais informações, consulte 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 usa o parâmetro Path para definir o local atual para o provedor Alias:do Registro. O Get-Location cmdlet exibe o caminho completo para Alias:. Get-ChildItem envia objetos pelo pipeline para o Out-File cmdlet . Out-File usa o parâmetro FilePath para especificar o caminho completo e o nome do arquivo para a saída, C:\TestDir\AliasNames.txt. O Get-Content cmdlet usa o parâmetro Path e exibe o conteúdo do arquivo no console do PowerShell.

Parâmetros

-Append

Adiciona a saída ao final de um arquivo existente. Se nenhuma Codificação for especificada, o cmdlet usará a codificação padrão. Essa codificação pode não corresponder à codificação do arquivo de destino. Esse é o mesmo comportamento que o operador de redirecionamento (>>).

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

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encoding

Especifica o tipo de codificação para o arquivo de destino. O valor padrão é Unicode.

Os valores aceitáveis para esse parâmetro são os seguintes:

  • ASCII Usa conjunto de caracteres ASCII (7 bits).
  • Bigendianunicode Usa UTF-16 com a ordem de bytes big-endian.
  • Padrão Usa a codificação que corresponde à página de código ativa do sistema (geralmente ANSI).
  • OEM Usa a codificação que corresponde à página de código OEM atual do sistema.
  • String O mesmo que Unicode.
  • Unicode Usa UTF-16 com a ordem de bytes little-endian.
  • Desconhecido O mesmo que Unicode.
  • UTF7 Usa UTF-7.
  • UTF8 Usa UTF-8.
  • UTF32 Usa UTF-32 com a ordem de bytes little-endian.
Type:String
Accepted values:ASCII, BigEndianUnicode, Default, OEM, String, Unicode, Unknown, UTF7, UTF8, UTF32
Position:1
Default value:Unicode
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FilePath

Especifica o caminho para o arquivo de saída.

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

-Force

Substitui o atributo somente leitura e substitui um arquivo somente leitura existente. O parâmetro Force não substitui as restrições de segurança.

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

-InputObject

Especifica os objetos a serem gravados no arquivo. Insira uma variável que contém os objetos ou digite um comando ou uma expressão que obtém os objetos.

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

-LiteralPath

Especifica o caminho para o arquivo de saída. O parâmetro LiteralPath é usado exatamente como é digitado. Caracteres curinga não são aceitos. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape. Para obter mais informações, consulte about_Quoting_Rules.

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

-NoClobber

O NoClobber impede que um arquivo existente seja substituído e exibe uma mensagem informando que o arquivo já existe. Por padrão, se existir um arquivo no caminho especificado, Out-File substituirá o arquivo sem aviso.

Type:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoNewline

Especifica que o conteúdo gravado no arquivo não termina com um caractere de nova linha. As representações de cadeia de caracteres dos objetos de entrada são concatenadas para formar a saída. Não são inseridos espaços ou novas linhas entre as cadeias de caracteres de saída. Nenhuma nova linha é adicionada após a última cadeia de caracteres de saída.

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Width

Especifica o número de caracteres em cada linha de saída. Quaisquer eventuais caracteres adicionais ficam truncados, não encapsulados. Se esse parâmetro não for usado, a largura será determinada pelas características do host. O padrão para o console do PowerShell é 80 caracteres.

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

Entradas

PSObject

Você pode redirecionar qualquer objeto para Out-File.

Saídas

None

Out-File não gera nenhuma saída.

Observações

Os Out cmdlets não formatizam objetos; eles apenas os renderizam e os enviam para o destino de exibição especificado. Se você enviar um objeto não formatado para um Out cmdlet, o cmdlet o enviará para um cmdlet de formatação antes de renderizá-lo.

Para enviar a saída de um comando do PowerShell para o Out-File cmdlet, use o pipeline. Você pode armazenar dados em uma variável e usar o parâmetro InputObject para passar dados para o Out-File cmdlet .

Out-File envia dados, mas não produz nenhum objeto de saída. Se você redirecionar a saída de Out-File para Get-Member, o Get-Member cmdlet relatará que nenhum objeto foi especificado.