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

Cmdleten Out-File skickar utdata till en fil. Den använder implicit PowerShells formateringssystem för att skriva till filen. Filen får samma visningsrepresentation som terminalen. Det innebär att utdata kanske inte är idealiska för programmatisk bearbetning om inte alla indataobjekt är strängar.

Omdirigering av utdata från ett PowerShell-kommando (cmdlet, funktion, skript) med omdirigeringsoperatorn (>) är funktionellt likvärdigt med rördragning till Out-File utan extra parametrar. PowerShell 7.4 ändrade beteendet för omdirigeringsoperatorn när den användes för att omdirigera stdout- ström av ett internt kommando. Mer information om omdirigering finns i about_Redirection.

Det här exemplet visar hur du skickar en lista över den lokala datorns processer till en fil. Om filen inte finns skapar Out-File filen i den angivna sökvägen.

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

Cmdleten Get-Process hämtar listan över processer som körs på den lokala datorn. Objekten Process skickas ned i pipelinen till cmdleten Out-File. Out-File använder parametern FilePath och skapar en fil i den aktuella katalogen med namnet Process.txt. Kommandot Get-Content hämtar innehåll från filen och visar det i PowerShell-konsolen.

Det här exemplet förhindrar att en befintlig fil skrivs över. Som standard skriver Out-File över befintliga filer.

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

Cmdleten Get-Process hämtar listan över processer som körs på den lokala datorn. Objekten Process skickas ned i pipelinen till cmdleten Out-File. Out-File använder parametern FilePath och försöker skriva till en fil i den aktuella katalogen med namnet Process.txt. Parametern NoClobber förhindrar att filen skrivs över och visar ett meddelande om att filen redan finns.

Det här exemplet visar hur du kodar utdata med en specifik kodningstyp.

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

Cmdleten Get-Process hämtar listan över processer som körs på den lokala datorn. Objekten Process lagras i variabeln $Procs. Out-File använder parametern FilePath och skapar en fil i den aktuella katalogen med namnet Process.txt. Parametern InputObject skickar processobjekten i $Procs till filen Process.txt. Parametern Kodning konverterar utdata till ASCII- format. Parametern Width begränsar varje rad i filen till 50 tecken så att vissa data kan trunkeras.

Det här exemplet visar hur du använder cmdleten Out-File när du inte är i en FileSystem- providerenhet. Använd cmdleten Get-PSProvider för att visa leverantörerna på din lokala dator. Mer information finns i om_Leverantörer.

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

Kommandot Set-Location använder parametern Path för att ange den aktuella platsen till registerprovidern Alias:. Cmdleten Get-Location visar den fullständiga sökvägen för Alias:. Get-ChildItem skickar objekt ned i pipelinen till cmdleten Out-File. Out-File använder parametern FilePath för att ange den fullständiga sökvägen och filnamnet för utdata C:\TestDir\AliasNames.txt. Cmdleten Get-Content använder parametern Path och visar filens innehåll i PowerShell-konsolen.

I det här exemplet används $PSDefaultParameterValues för att ange parametern Width för alla anrop av Out-File och omdirigeringsoperatorerna (> och >>) till 2000. Detta säkerställer att PowerShell överallt inom det aktuella omfånget som du matar ut tabellformaterade data till fil använder en radbredd på 2 000 i stället för en linjebredd som bestäms av PowerShell-värdens konsolbredd.

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

Mer information om $PSDefaultParameterValuesfinns i about_Preference_Variables.

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Du kan skicka valfritt objekt till den här cmdleten.

Den här cmdleten returnerar inga utdata.

Indataobjekt formateras automatiskt som de skulle vara i terminalen, men du kan använda en Format-*-cmdlet för att uttryckligen styra formateringen av utdata till filen. Till exempel: Get-Date | Format-List | Out-File out.txt

Om du vill skicka utdata från ett PowerShell-kommando till cmdleten Out-File använder du pipelinen. Du kan också lagra data i en variabel och använda parametern InputObject för att skicka data till cmdleten Out-File.

Out-File sparar data i en fil, men det skapar inga utdataobjekt till pipelinen.

PowerShell 7.2 har lagt till möjligheten att styra hur ANSI-escape-sekvenser återges. ANSI-dekorerade utdata som skickas till Out-File kan ändras baserat på inställningen för egenskapen $PSStyle.OutputRendering. Mer information finns i about_ANSI_Terminals.