Out-File

模組:

Microsoft.PowerShell.Utility

將輸出傳送到檔案。

Syntax

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

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

Description

Cmdlet 會將 Out-File 輸出傳送至檔案。 當您需要指定輸出使用 Out-File 的參數時，而不是重新導向運算符 (>) 。

範例

範例 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 物件會向下傳送至 Cmdlet 的Out-File管線。 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 物件會向下傳送至 Cmdlet 的Out-File管線。 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：使用提供者並將輸出傳送至檔案

此範例示範當您不在 FileSystem 提供者磁碟驅動器中時，如何使用 Out-File 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:。 Cmdlet Get-Location 會顯示 的完整路徑 Alias:。 Get-ChildItem 將管線中的物件向下傳送至 Out-File Cmdlet。 Out-File 使用 FilePath 參數來指定輸出的完整路徑和檔案名， C:\TestDir\AliasNames.txt。 Cmdlet Get-Content 會使用 Path 參數，並在 PowerShell 控制台中顯示檔案的內容。

參數

-Append

將輸出新增至現有檔案的結尾。 如果未指定 Encoding，Cmdlet 會使用預設編碼。 該編碼可能不符合目標檔案的編碼方式。 此行為與重新導向運算子 >> () 相同。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

在執行 Cmdlet 前提示您確認。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encoding

指定目標檔案的編碼類型。 預設值為 Unicode。

此參數可接受的值如下所示：

• Ascii 使用 ASCII (7 位) 字元集。
• BigEndianUnicode 使用UTF-16搭配位元組位元組順序。
• 預設 使用對應至系統使用中代碼頁的編碼， (通常是 ANSI) 。
• Oem 使用對應至系統目前 OEM 代碼頁的編碼方式。
• 字串 與 Unicode 相同。
• Unicode 使用UTF-16搭配位元組位元組順序。
• 未知 與 Unicode 相同。
• UTF7 使用UTF-7。
• UTF8 使用UTF-8。
• UTF32 使用UTF-32搭配位元組位元組順序。

Type:	String
Accepted values:	ASCII, BigEndianUnicode, Default, OEM, String, Unicode, Unknown, UTF7, UTF8, UTF32
Position:	1
Default value:	Unicode
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilePath

指定輸出檔案的路徑。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

Type:	PSObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-LiteralPath

指定輸出檔案的路徑。 LiteralPath 參數會與類型完全相同使用。 不接受通配符。 如果路徑包含逸出字元，請將它括在單引號中。 單引號會指示PowerShell不要將任何字元解譯為逸出序列。 如需詳細資訊，請參閱 about_Quoting_Rules。

Type:	String
Aliases:	PSPath
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-NoClobber

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

Type:	SwitchParameter
Aliases:	NoOverwrite
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoNewline

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Width

指定每一行輸出的字元數目。 任何額外的字元都會被截斷，而不會換行顯示。 如果未使用此參數，寬度是由主機的特性所決定。 PowerShell 控制台的預設值為 80 個字元。

Type:	Int
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

PSObject

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

輸出

None

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

備註

Cmdlet Out 不會格式化物件;它們只會轉譯物件，並將其傳送至指定的顯示目的地。 如果您將未格式化的對象傳送至 Out Cmdlet，Cmdlet 會在轉譯之前將其傳送至格式化 Cmdlet。

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

Out-File 會傳送數據，但不會產生任何輸出物件。 如果您使用管線將 的 Out-File 輸出傳送至 Get-Member，Cmdlet 會 Get-Member 報告未指定任何物件。

相關連結

• about_Providers
• about_Quoting_Rules
• Out-Default
• Out-GridView
• Out-Host
• Out-Null
• Out-Printer
• Out-String
• Tee-Object