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

L’applet de commande Out-File envoie la sortie à un fichier. Il utilise implicitement le système de mise en forme de PowerShell pour écrire dans le fichier. Le fichier reçoit la même représentation d’affichage que le terminal. Cela signifie que la sortie peut ne pas être idéale pour le traitement par programmation, sauf si tous les objets d’entrée sont des chaînes.

La redirection de la sortie d’une commande PowerShell (applet de commande, fonction, script) à l’aide de l’opérateur de redirection (>) est fonctionnellement équivalente à la piping vers Out-File sans paramètres supplémentaires. PowerShell 7.4 a modifié le comportement de l’opérateur de redirection lorsqu’il est utilisé pour rediriger le stdout flux d’une commande native. Pour plus d’informations sur la redirection, consultez about_Redirection.

Cet exemple montre comment envoyer une liste des processus de l’ordinateur local à un fichier. Si le fichier n’existe pas, Out-File crée le fichier dans le chemin d’accès spécifié.

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

L’applet de commande Get-Process obtient la liste des processus en cours d’exécution sur l’ordinateur local. Les objets Process sont envoyés au pipeline à l’applet de commande Out-File. Out-File utilise le paramètre FilePath et crée un fichier dans le répertoire actif nommé Process.txt. La commande Get-Content obtient le contenu du fichier et l’affiche dans la console PowerShell.

Cet exemple empêche le remplacement d’un fichier existant. Par défaut, Out-File remplace les fichiers existants.

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

L’applet de commande Get-Process obtient la liste des processus en cours d’exécution sur l’ordinateur local. Les objets Process sont envoyés au pipeline à l’applet de commande Out-File. Out-File utilise le paramètre FilePath et tente d’écrire dans un fichier dans le répertoire actif nommé Process.txt. Le paramètre NoClobber empêche le fichier d’être remplacé et affiche un message indiquant que le fichier existe déjà.

Cet exemple montre comment encoder la sortie avec un type d’encodage spécifique.

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

L’applet de commande Get-Process obtient la liste des processus en cours d’exécution sur l’ordinateur local. Les objets Process sont stockés dans la variable, $Procs. Out-File utilise le paramètre FilePath et crée un fichier dans le répertoire actif nommé Process.txt. Le paramètre InputObject transmet les objets de processus dans $Procs au fichier Process.txt. Le paramètre d’encodage convertit la sortie au format ASCII. Le paramètre Width limite chaque ligne du fichier à 50 caractères afin que certaines données puissent être tronquées.

Cet exemple montre comment utiliser l’applet de commande Out-File lorsque vous n’êtes pas dans un lecteur de fournisseur fileSystem . Utilisez l’applet de commande Get-PSProvider pour afficher les fournisseurs sur votre ordinateur local. Pour plus d’informations, voir 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

La commande Set-Location utilise le paramètre Path pour définir l’emplacement actuel sur le fournisseur de Registre Alias:. L’applet de commande Get-Location affiche le chemin d’accès complet de Alias:. Get-ChildItem envoie des objets vers le pipeline à l’applet de commande Out-File. Out-File utilise le paramètre FilePath pour spécifier le chemin d’accès complet et le nom de fichier de la sortie, C:\TestDir\AliasNames.txt. L’applet de commande Get-Content utilise le paramètre path et affiche le contenu du fichier dans la console PowerShell.

Cet exemple utilise $PSDefaultParameterValues pour définir le paramètre Width pour tous les appels de Out-File et les opérateurs de redirection (> et >>) sur 2000. Cela garantit que partout dans l’étendue actuelle que vous extrayez les données mises en forme du tableau dans un fichier, PowerShell utilise une largeur de ligne de 2000 au lieu d’une largeur de ligne déterminée par la largeur de la console de l’hôte 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

Pour plus d’informations sur $PSDefaultParameterValues, consultez about_Preference_Variables.

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Vous pouvez diriger n’importe quel objet vers cette applet de commande.

Cette applet de commande ne retourne aucune sortie.

Les objets d’entrée sont automatiquement mis en forme comme dans le terminal, mais vous pouvez utiliser une applet de commande Format-* pour contrôler explicitement la mise en forme de la sortie dans le fichier. Par exemple, Get-Date | Format-List | Out-File out.txt

Pour envoyer la sortie d’une commande PowerShell à l’applet de commande Out-File, utilisez le pipeline. Vous pouvez également stocker des données dans une variable et utiliser le paramètre InputObject pour transmettre des données à l’applet de commande Out-File.

Out-File enregistre des données dans un fichier, mais elle ne produit aucun objet de sortie dans le pipeline.

PowerShell 7.2 a ajouté la possibilité de contrôler le rendu des séquences d’échappement ANSI. La sortie décorée d’ANSI passée à Out-File peut être modifiée en fonction du paramètre de la propriété $PSStyle.OutputRendering. Pour plus d’informations, consultez about_ANSI_Terminals.