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

De cmdlet Out-File verzendt uitvoer naar een bestand. Het maakt impliciet gebruik van het opmaaksysteem van PowerShell om naar het bestand te schrijven. Het bestand ontvangt dezelfde weergaveweergave als de terminal. Dit betekent dat de uitvoer mogelijk niet ideaal is voor programmatische verwerking, tenzij alle invoerobjecten tekenreeksen zijn.

Het omleiden van de uitvoer van een PowerShell-opdracht (cmdlet, functie, script) met behulp van de omleidingsoperator (>) is functioneel gelijk aan pijpen naar Out-File zonder extra parameters. PowerShell 7.4 heeft het gedrag van de omleidingsoperator gewijzigd wanneer deze wordt gebruikt om de stdout- stroom van een systeemeigen opdracht om te leiden. Zie about_Redirectionvoor meer informatie over omleiding.

In dit voorbeeld ziet u hoe u een lijst met processen van de lokale computer naar een bestand verzendt. Als het bestand niet bestaat, maakt Out-File het bestand in het opgegeven pad.

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

De cmdlet Get-Process haalt de lijst met processen op die op de lokale computer worden uitgevoerd. De Process-objecten worden naar de Out-File-cmdlet verzonden. Out-File gebruikt de parameter FilePath en maakt u een bestand in de huidige map met de naam Process.txt. Met de opdracht Get-Content wordt inhoud uit het bestand opgehaald en weergegeven in de PowerShell-console.

In dit voorbeeld voorkomt u dat een bestaand bestand wordt overschreven. Standaard overschrijft Out-File bestaande bestanden.

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

De cmdlet Get-Process haalt de lijst met processen op die op de lokale computer worden uitgevoerd. De Process-objecten worden naar de Out-File-cmdlet verzonden. Out-File gebruikt de parameter FilePath en probeert naar een bestand te schrijven in de huidige map met de naam Process.txt. De parameter NoClobber voorkomt dat het bestand wordt overschreven en geeft een bericht weer dat het bestand al bestaat.

In dit voorbeeld ziet u hoe u uitvoer coderen met een specifiek coderingstype.

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

De cmdlet Get-Process haalt de lijst met processen op die op de lokale computer worden uitgevoerd. De Process-objecten worden opgeslagen in de variabele, $Procs. Out-File gebruikt de parameter FilePath en maakt u een bestand in de huidige map met de naam Process.txt. De parameter InputObject geeft de procesobjecten in $Procs door aan het bestand Process.txt. De parameter Codering converteert de uitvoer naar ASCII--indeling. De parameter Width beperkt elke regel in het bestand tot 50 tekens, zodat sommige gegevens mogelijk worden afgekapt.

In dit voorbeeld ziet u hoe u de cmdlet Out-File gebruikt wanneer u zich niet in een bestandssysteem bevindt providerstation. Gebruik de cmdlet Get-PSProvider om de providers op uw lokale computer weer te geven. Zie about_Providersvoor meer informatie.

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

De opdracht Set-Location gebruikt de parameter Path om de huidige locatie in te stellen op de registerprovider Alias:. Met de cmdlet Get-Location wordt het volledige pad voor Alias:weergegeven. Get-ChildItem objecten in de pijplijn naar de cmdlet Out-File verzendt. Out-File gebruikt de parameter FilePath om het volledige pad en de bestandsnaam voor de uitvoer op te geven, C:\TestDir\AliasNames.txt. De cmdlet Get-Content maakt gebruik van de parameter Path en geeft de inhoud van het bestand weer in de PowerShell-console.

In dit voorbeeld wordt $PSDefaultParameterValues gebruikt om de parameter Width in te stellen voor alle aanroepen van Out-File en de omleidingsoperators (> en >>) op 2000. Dit zorgt ervoor dat powerShell overal binnen het huidige bereik gegevens uitvoert die zijn opgemaakt voor bestanden, een lijnbreedte van 2000 gebruikt in plaats van een lijnbreedte die wordt bepaald door de consolebreedte van de PowerShell-host.

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

Voor meer informatie over $PSDefaultParameterValues, zie about_Preference_Variables.

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

U kunt elk object doorsluisen naar deze cmdlet.

Deze cmdlet retourneert geen uitvoer.

Invoerobjecten worden automatisch opgemaakt zoals ze in de terminal zouden staan, maar u kunt een Format-* cmdlet gebruiken om expliciet de opmaak van de uitvoer naar het bestand te beheren. Bijvoorbeeld Get-Date | Format-List | Out-File out.txt

Gebruik de pijplijn om de uitvoer van een PowerShell-opdracht naar de Out-File-cmdlet te verzenden. U kunt ook gegevens opslaan in een variabele en de parameter InputObject gebruiken om gegevens door te geven aan de Out-File-cmdlet.

Out-File gegevens opslaat in een bestand, maar er worden geen uitvoerobjecten naar de pijplijn geproduceerd.

PowerShell 7.2 heeft de mogelijkheid toegevoegd om te bepalen hoe ANSI-escapereeksen worden weergegeven. ANSI-ingerichte uitvoer die wordt doorgegeven aan Out-File kan worden gewijzigd op basis van de instelling van de eigenschap $PSStyle.OutputRendering. Zie about_ANSI_Terminalsvoor meer informatie.