Out-File

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

Out-File コマンドレットは、出力をファイルに送信します。 出力のパラメータを指定する必要がある場合は、リダイレクト演算子 (Out-File) ではなく > を使用します。

この例では、ローカル コンピューターのプロセスの一覧をファイルに送信する方法を示します。 ファイルが存在しない場合は、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 コマンドレットは、ローカル コンピューターで実行されているプロセスの一覧を取得します。 Process オブジェクトは、パイプラインから Out-File コマンドレットに送信されます。 Out-File は、FilePath パラメーターを使用して、Process.txtという名前の現在のディレクトリにファイルを作成します。 Get-Content コマンドは、ファイルからコンテンツを取得し、PowerShell コンソールに表示します。

この例では、既存のファイルが上書きされないようにします。 既定では、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 コマンドレットは、ローカル コンピューターで実行されているプロセスの一覧を取得します。 Process オブジェクトは、パイプラインから Out-File コマンドレットに送信されます。 Out-File は、FilePath パラメーターを使用し、Process.txtという名前の現在のディレクトリ内のファイルへの書き込みを試みます。 NoClobber パラメーターは、ファイルが上書きされないようにし、ファイルが既に存在することを示すメッセージを表示します。

この例では、特定のエンコードの種類で出力をエンコードする方法を示します。

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

Get-Process コマンドレットは、ローカル コンピューターで実行されているプロセスの一覧を取得します。 Process オブジェクトは、$Procs変数に格納されます。 Out-File は、FilePath パラメーターを使用して、Process.txtという名前の現在のディレクトリにファイルを作成します。 InputObject パラメーターは、$Procs 内のプロセス オブジェクトをファイル Process.txtに渡します。 Encoding パラメーターは、出力を ASCII 形式 変換します。 Width パラメーターは、一部のデータが切り捨てられる可能性があるため、ファイル内の各行を 50 文字に制限します。

この例では、Out-File プロバイダー ドライブにいないときに コマンドレットを使用する方法を示します。 Get-PSProvider コマンドレットを使用して、ローカル コンピューター上のプロバイダーを表示します。 詳細については、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 コマンドレットは、Alias:の完全なパスを表示します。 Get-ChildItem は、パイプラインの下にオブジェクトを Out-File コマンドレットに送信します。 Out-File では、FilePath パラメーターを使用して、出力の完全なパスとファイル名を指定 C:\TestDir\AliasNames.txt。 Get-Content コマンドレットは、Path パラメーターを使用し、PowerShell コンソールにファイルの内容を表示します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

任意のオブジェクトをパイプ処理して Out-Fileできます。

Out-File は出力を生成しません。

Out コマンドレットは、オブジェクトを書式設定せず、単にオブジェクトをレンダリングして、指定した表示先に送信するだけです。 書式設定されていないオブジェクトを Out コマンドレットに送信すると、そのオブジェクトをレンダリングする前に、そのオブジェクトが書式設定コマンドレットに送信されます。

PowerShell コマンドの出力を Out-File コマンドレットに送信するには、パイプラインを使用します。 データを変数に格納し、 InputObject パラメーターを使用してデータを Out-File コマンドレットに渡すことができます。

Out-File はデータを送信しますが、出力オブジェクトは生成されません。 Out-File の出力を Get-Member にパイプ処理すると、Get-Member コマンドレットはオブジェクトが指定されていないことを報告します。