Out-File

Odwołanie

Moduł:: Microsoft.PowerShell.Utility

Wysyła dane wyjściowe do pliku.

Składnia

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

Opis

Polecenie Out-File cmdlet wysyła dane wyjściowe do pliku. Niejawnie używa systemu formatowania programu PowerShell do zapisu w pliku. Plik otrzymuje tę samą reprezentację wyświetlania co terminal. Oznacza to, że dane wyjściowe mogą nie być idealne do przetwarzania programowego, chyba że wszystkie obiekty wejściowe są ciągami.

Przekierowywanie danych wyjściowych polecenia programu PowerShell (polecenia cmdlet, funkcji, skryptu) przy użyciu operatora przekierowania (>) jest funkcjonalnie równoważne potokowi bez Out-File dodatkowych parametrów. Program PowerShell 7.4 zmienił zachowanie operatora przekierowania, gdy był używany do przekierowywania strumienia stdout polecenia natywnego. Aby uzyskać więcej informacji na temat przekierowania, zobacz about_Redirection.

Przykłady

Przykład 1. Wysyłanie danych wyjściowych i tworzenie pliku

W tym przykładzie pokazano, jak wysłać listę procesów komputera lokalnego do pliku. Jeśli plik nie istnieje, Out-File tworzy plik w określonej ścieżce.

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

Polecenie Get-Process cmdlet pobiera listę procesów uruchomionych na komputerze lokalnym. Obiekty procesu są wysyłane w dół potoku Out-File do polecenia cmdlet. Out-File używa parametru FilePath i tworzy plik w bieżącym katalogu o nazwie Process.txt. Polecenie Get-Content pobiera zawartość z pliku i wyświetla ją w konsoli programu PowerShell.

Przykład 2. Zapobieganie zastępowaniu istniejącego pliku

W tym przykładzie nie można zastąpić istniejącego pliku. Domyślnie Out-File zastępuje istniejące pliki.

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

Polecenie Get-Process cmdlet pobiera listę procesów uruchomionych na komputerze lokalnym. Obiekty procesu są wysyłane w dół potoku Out-File do polecenia cmdlet. Out-File używa parametru FilePath i próbuje zapisać w pliku w bieżącym katalogu o nazwie Process.txt. Parametr NoClobber uniemożliwia zastąpienie pliku i wyświetla komunikat, że plik już istnieje.

Przykład 3. Wysyłanie danych wyjściowych do pliku w formacie ASCII

W tym przykładzie pokazano, jak kodować dane wyjściowe przy użyciu określonego typu kodowania.

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

Polecenie Get-Process cmdlet pobiera listę procesów uruchomionych na komputerze lokalnym. Obiekty procesu są przechowywane w zmiennej $Procs. Out-File używa parametru FilePath i tworzy plik w bieżącym katalogu o nazwie Process.txt. Parametr InputObject przekazuje obiekty procesu do $Procs pliku Process.txt. Parametr Kodowanie konwertuje dane wyjściowe na format ASCII . Parametr Width ogranicza każdy wiersz w pliku do 50 znaków, aby niektóre dane mogły zostać obcięte.

Przykład 4. Używanie dostawcy i wysyłanie danych wyjściowych do pliku

W tym przykładzie pokazano, jak używać Out-File polecenia cmdlet, gdy nie znajdujesz się na dysku dostawcy systemu plików . Get-PSProvider Użyj polecenia cmdlet , aby wyświetlić dostawców na komputerze lokalnym. Aby uzyskać więcej informacji, zobacz 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

Polecenie Set-Location używa parametru Path , aby ustawić bieżącą lokalizację dostawcy Alias:rejestru . Polecenie Get-Location cmdlet wyświetla pełną ścieżkę dla elementu Alias:. Get-ChildItem wysyła obiekty w dół potoku Out-File do polecenia cmdlet. Out-FileUżywa parametru FilePath, aby określić pełną ścieżkę i nazwę pliku dla danych wyjściowych, C:\TestDir\AliasNames.txt. Polecenie Get-Content cmdlet używa parametru Path i wyświetla zawartość pliku w konsoli programu PowerShell.

Przykład 5. Ustawianie szerokości danych wyjściowych pliku dla całego zakresu

W tym przykładzie użyto $PSDefaultParameterValues polecenia , aby ustawić Width parametr dla wszystkich wywołań operatorów Out-File przekierowania (> i >>) na wartość 2000. Dzięki temu program PowerShell używa szerokości linii 2000 zamiast szerokości wiersza określonej przez szerokość konsoli hosta programu PowerShell wszędzie w bieżącym zakresie, w którym są wyświetlane dane sformatowane w tabeli.

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

Aby uzyskać więcej informacji na temat $PSDefaultParameterValuesprogramu , zobacz about_Preference_Variables.

Parametry

-Append

Dodaje dane wyjściowe na końcu istniejącego pliku.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Domyślna wartość:	False
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Encoding

Określa typ kodowania dla pliku docelowego. Domyślna wartość to utf8NoBOM.

Dopuszczalne wartości tego parametru są następujące:

ascii: używa kodowania dla zestawu znaków ASCII (7-bitowych).
ansi: używa kodowania dla strony kodowej ANSI bieżącej kultury. Ta opcja została dodana w programie PowerShell 7.4.
bigendianunicode: Koduje w formacie UTF-16 przy użyciu kolejności bajtów big-endian.
bigendianutf32: Koduje w formacie UTF-32 przy użyciu kolejności bajtów big-endian.
oem: używa domyślnego kodowania dla programów MS-DOS i konsoli.
unicode: Koduje w formacie UTF-16 przy użyciu kolejności bajtów little-endian.
utf7: Koduje w formacie UTF-7.
utf8: Koduje w formacie UTF-8.
utf8BOM: Koduje w formacie UTF-8 za pomocą języka Byte Order Mark (BOM)
utf8NoBOM: Koduje w formacie UTF-8 bez znaku kolejności bajtów (BOM)
utf32: Koduje w formacie UTF-32.

Począwszy od programu PowerShell 6.2, parametr Kodowanie umożliwia również numeryczne identyfikatory zarejestrowanych stron kodu (takich jak ) lub nazwy ciągów zarejestrowanych stron kodu (na przykład -Encoding 1251-Encoding "windows-1251"). Aby uzyskać więcej informacji, zobacz dokumentację platformy .NET dotyczącą pliku Encoding.CodePage.

Począwszy od programu PowerShell 7.4, można użyć Ansi wartości parametru Kodowanie , aby przekazać identyfikator liczbowy dla strony kodowej ANSI bieżącej kultury bez konieczności ręcznego określania go.

Uwaga

UtF-7* nie jest już zalecane do użycia. Zgodnie z programem PowerShell 7.1 ostrzeżenie jest zapisywane w przypadku określenia utf7 parametru Kodowanie .

Typ:	Encoding
Dopuszczalne wartości:	ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:	1
Domyślna wartość:	UTF8NoBOM
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FilePath

Określa ścieżkę do pliku wyjściowego.

Typ:	String
Aliasy:	Path
Position:	0
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Force

Zastępuje atrybut tylko do odczytu i zastępuje istniejący plik tylko do odczytu. Parametr Force nie zastępuje ograniczeń zabezpieczeń.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-InputObject

Określa obiekty, które mają być zapisywane w pliku. Wprowadź zmienną zawierającą obiekty lub wpisz polecenie lub wyrażenie, które pobiera obiekty.

Typ:	PSObject
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-LiteralPath

Określa ścieżkę do pliku wyjściowego. Parametr LiteralPath jest używany dokładnie tak, jak został wpisany. Symbole wieloznaczne nie są akceptowane. Jeśli ścieżka zawiera znaki ucieczki, należy ująć ją w pojedynczy cudzysłów. Pojedyncze znaki cudzysłowu informują program PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki. Aby uzyskać więcej informacji, zobacz about_Quoting_Rules.

Typ:	String
Aliasy:	PSPath, LP
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-NoClobber

Polecenie NoClobber uniemożliwia zastąpienie istniejącego pliku i wyświetla komunikat, że plik już istnieje. Domyślnie, jeśli plik istnieje w określonej ścieżce, Out-File zastępuje plik bez ostrzeżenia.

Typ:	SwitchParameter
Aliasy:	NoOverwrite
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-NoNewline

Określa, że zawartość zapisana w pliku nie kończy się znakiem nowego wiersza. Reprezentacje ciągów obiektów wejściowych są łączone w celu utworzenia danych wyjściowych. Między ciągami wyjściowymi nie są wstawione spacje ani nowe linie. Nie dodano nowego wiersza po ostatnim ciągu danych wyjściowych.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie jest uruchamiane.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Domyślna wartość:	False
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Width

Określa maksymalną liczbę znaków w każdym wierszu danych wyjściowych. Wszelkie dodatkowe znaki są obcinane, nie owinięte. Jeśli ten parametr nie jest używany, szerokość jest określana przez cechy hosta. Domyślną wartością konsoli programu PowerShell jest 80 znaków. Jeśli chcesz kontrolować szerokość dla wszystkich wywołań, a także operatorów Out-File przekierowania (> i >>), ustaw $PSDefaultParameterValues['out-file:width'] = 2000 przed użyciem polecenia Out-File.

Typ:	Int32
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

PSObject

Do tego polecenia cmdlet można przekazać dowolny obiekt.

Dane wyjściowe

None

To polecenie cmdlet nie zwraca żadnych danych wyjściowych.

Uwagi

Obiekty wejściowe są automatycznie formatowane tak, jak w terminalu, ale można użyć Format-* polecenia cmdlet, aby jawnie kontrolować formatowanie danych wyjściowych w pliku. Na przykład Get-Date | Format-List | Out-File out.txt

Aby wysłać dane wyjściowe polecenia programu PowerShell do Out-File polecenia cmdlet, użyj potoku. Alternatywnie można przechowywać dane w zmiennej i użyć parametru InputObject , aby przekazać dane do Out-File polecenia cmdlet.

Out-File zapisuje dane w pliku, ale nie generuje żadnych obiektów wyjściowych w potoku.

Program PowerShell 7.2 dodał możliwość kontrolowania sposobu renderowania sekwencji ucieczki ANSI. Dane wyjściowe ozdobione za pomocą interfejsu $PSStyle.OutputRendering ANSI, które są przekazywaneOut-File, można zmienić na podstawie ustawienia właściwości. Aby uzyskać więcej informacji, zobacz about_ANSI_Terminals.

Udostępnij za pośrednictwem

Out-File

Składnia

Opis

Przykłady

Przykład 1. Wysyłanie danych wyjściowych i tworzenie pliku

Przykład 2. Zapobieganie zastępowaniu istniejącego pliku

Przykład 3. Wysyłanie danych wyjściowych do pliku w formacie ASCII

Przykład 4. Używanie dostawcy i wysyłanie danych wyjściowych do pliku

Przykład 5. Ustawianie szerokości danych wyjściowych pliku dla całego zakresu

Parametry

-Append

-Confirm

-Encoding

-FilePath

-Force

-InputObject

-LiteralPath

-NoClobber

-NoNewline

-WhatIf

-Width

Dane wejściowe

Dane wyjściowe

Uwagi

Dodatkowe zasoby

Udostępnij za pośrednictwem

Out-File

Składnia

Opis

Przykłady

Przykład 1. Wysyłanie danych wyjściowych i tworzenie pliku

Przykład 2. Zapobieganie zastępowaniu istniejącego pliku

Przykład 3. Wysyłanie danych wyjściowych do pliku w formacie ASCII

Przykład 4. Używanie dostawcy i wysyłanie danych wyjściowych do pliku

Przykład 5. Ustawianie szerokości danych wyjściowych pliku dla całego zakresu

Parametry

-Append

-Confirm

-Encoding

-FilePath

-Force

-InputObject

-LiteralPath

-NoClobber

-NoNewline

-WhatIf

-Width

Dane wejściowe

Dane wyjściowe

Uwagi

Linki powiązane

Dodatkowe zasoby