Out-File

模組:: Microsoft.PowerShell.Utility Module

將輸出傳送至檔案。

語法

ByPath (預設值)

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

ByLiteralPath

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

Description

Out-File Cmdlet 會將輸出傳送至檔案。它會隱含地使用PowerShell的格式設定系統來寫入檔案。檔案會接收與終端機相同的顯示表示法。這表示除非所有輸入物件都是字串，否則輸出可能不適合以程式設計方式處理。當您需要指定輸出的參數時，請使用 Out-File 而非重新導向運算符（>）。如需重新導向的詳細資訊，請參閱 about_Redirection。

範例

範例 1：傳送輸出並建立檔案

此範例示範如何將本機計算機進程清單傳送至檔案。如果檔案不存在，Out-File 會在指定的路徑中建立檔案。

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

Get-Process Cmdlet 會取得本機電腦上執行的進程清單。 Process 物件會從管線向下傳送至 Out-File Cmdlet。 Out-File 會使用 FilePath 參數，並在名為 Process.txt的目前目錄中建立檔案。 Get-Content 命令會從檔案取得內容，並在 PowerShell 控制台中顯示它。

範例 2：防止覆寫現有的檔案

此範例會防止覆寫現有的檔案。根據預設，Out-File 會覆寫現有的檔案。

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

Get-Process Cmdlet 會取得本機電腦上執行的進程清單。 Process 物件會從管線向下傳送至 Out-File Cmdlet。 Out-File 會使用 FilePath 參數，並嘗試寫入目前目錄中名為 Process.txt的檔案。 NoClobber 參數可防止覆寫檔案，並顯示檔案已經存在的訊息。

範例 3：以 ASCII 格式將輸出傳送至檔案

此範例示範如何使用特定編碼類型來編碼輸出。

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

Get-Process Cmdlet 會取得本機電腦上執行的進程清單。 Process 物件會儲存在變數中，$Procs。 Out-File 會使用 FilePath 參數，並在名為 Process.txt的目前目錄中建立檔案。 InputObject 參數會將 $Procs 中的行程物件傳遞至檔案 Process.txt。 Encoding 參數會將輸出轉換成 ASCII 格式。 Width 參數會將檔案中的每個行限制為 50 個字元，因此可能會截斷某些數據。

範例 4：使用提供者並將輸出傳送至檔案

此示例演示如何在不 Out-File 在 FileSystem 提供程式驅動器中時使用 cmdlet。使用 Get-PSProvider Cmdlet 來檢視本機電腦上的提供者。如需詳細資訊，請參閱 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

Set-Location 命令會使用 Path 參數，將目前的位置設定為登錄提供者 Alias:。 Get-Location Cmdlet 會顯示 Alias:的完整路徑。 Get-ChildItem 將物件向下傳送至 Out-File Cmdlet。 Out-File 會使用 FilePath 參數來指定輸出的完整路徑和檔名，C:\TestDir\AliasNames.txt。 Get-Content Cmdlet 會使用 Path 參數，並在 PowerShell 控制台中顯示檔案的內容。

範例 5：設定整個範圍的檔案輸出寬度

此示例用於$PSDefaultParameterValues將重定向作器（> 和 >>）的所有數據用Out-File的參數設定為 Width 2000。這是一種簡單的方法，可確保在將表格式數據輸出到檔的範圍內的任何地方，PowerShell 將使用 2000 的線寬，而不是由 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

如需 $PSDefaultParameterValues的詳細資訊，請參閱 about_Preference_Variables。

參數

-Append

將輸出新增至現有檔案的結尾。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	cf

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Encoding

指定目標檔案的編碼類型。預設值是 utf8NoBOM。

此參數可接受的值如下：

ascii：使用 ASCII （7 位）字元集的編碼方式。
bigendianunicode：使用高位元組序以 UTF-16 格式編碼。
bigendianutf32：使用大端字節順序以 UTF-32 格式進行編碼。
oem：使用 MS-DOS 和控制台程序的預設編碼方式。
unicode：使用小端位元組順序，以UTF-16格式進行編碼。
utf7：以UTF-7格式編碼。
utf8：以UTF-8格式編碼。
utf8BOM：以 UTF-8 格式（含位元組順序標記 BOM）編碼
utf8NoBOM：以 UTF-8 格式編碼，不含位元組順序標記【BOM】
utf32：以UTF-32格式編碼。

從 PowerShell 6.2 開始，編碼參數也允許已註冊代碼頁的數值識別元（例如 -Encoding 1251）或已註冊代碼頁的字串名稱（例如 -Encoding "windows-1251"）。如需詳細資訊，請參閱 Encoding.CodePage的 .NET 檔。

備註

UTF-7* 不再建議使用。自 PowerShell 7.1 起，如果您為 utf7 參數指定，則會撰寫警告。

參數屬性

類型:	Encoding
預設值:	UTF8NoBOM
接受的值:	ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	1
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-FilePath

指定輸出檔案的路徑。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	路徑

參數集

ByPath

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Force

覆寫唯讀屬性，並覆寫現有的唯讀檔案。 Force 參數不會覆寫安全性限制。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-InputObject

指定要寫入檔案的物件。輸入包含物件的變數，或輸入取得物件的命令或表達式。

參數屬性

類型:	PSObject
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-LiteralPath

指定輸出檔案的路徑。 LiteralPath 參數的使用方式與鍵入的參數完全相同。不接受萬用字元。如果路徑包含逸出字元，請以單引弧括住它。單引號會告知PowerShell不要將任何字元解譯為逸出序列。如需詳細資訊，請參閱 about_Quoting_Rules。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	PSPath, LP

參數集

ByLiteralPath

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-NoClobber

NoClobber 會防止覆寫現有的檔案，並顯示檔案已經存在的訊息。根據預設，如果檔案存在於指定的路徑中，Out-File 會覆寫檔案而不發出警告。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	NoOverwrite

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-NoNewline

指定寫入檔案的內容不以換行符結尾。輸入物件的字串表示會串連以形成輸出。輸出字串之間不會插入空格或換行符。最後一個輸出字串之後不會新增任何換行符。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	無線

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Width

指定每行輸出中的字元數。任何其他字元都會被截斷，不會包裝。如果不使用此參數，則寬度由主機的特徵決定。 PowerShell 控制台的預設值為 80 個字元。如果您想要控制所有叫用 Out-File 的寬度，以及重新導向運算子（> 和 >>），請先設定 $PSDefaultParameterValues['out-file:width'] = 2000，再使用 Out-File。

參數屬性

類型:	Int32
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

輸入

PSObject

您可以使用管線將任何物件傳送至 Out-File。

輸出

None

Out-File 不會產生任何輸出。

備註

輸入物件會在終端機中自動格式化，但您可以使用 Format-* Cmdlet 來明確控制輸出到檔案的格式。例如， Get-Date | Format-List | Out-File out.txt

若要將PowerShell命令的輸出傳送至 Out-File Cmdlet，請使用管線。或者，您可以將數據儲存在變數中，並使用 InputObject 參數將數據傳遞至 Out-File Cmdlet。

Out-File 將資料保存到檔，但不會向管道生成任何輸出物件。

共用方式為

Out-File

語法

ByPath (預設值)

ByLiteralPath

Description

範例

範例 1：傳送輸出並建立檔案

範例 2：防止覆寫現有的檔案

範例 3：以 ASCII 格式將輸出傳送至檔案

範例 4：使用提供者並將輸出傳送至檔案

範例 5：設定整個範圍的檔案輸出寬度

參數

-Append

參數屬性

參數集

-Confirm

參數屬性

參數集

-Encoding

參數屬性

參數集

-FilePath

參數屬性

參數集

-Force

參數屬性

參數集

-InputObject

參數屬性

參數集

-LiteralPath

參數屬性

參數集

-NoClobber

參數屬性

參數集

-NoNewline

參數屬性

參數集

-WhatIf

參數屬性

參數集

-Width

參數屬性

參數集

CommonParameters

輸入

PSObject

輸出

None

備註

相關連結