HOME > File系コマンドレット > Out-File
Out-File
Out-Fileは、オブジェクトをファイルに出力するコマンドです。
エイリアスなし
解説
指定したオブジェクトをファイルに出力します。
出力時に文字コードを指定できます。
構文
- （構文）
- Out-File [-FilePath] <string> [[-Encoding] <文字コード>] [<CommonParameters>] Out-File [[-Encoding] <文字コード>] [<CommonParameters>]
| パラメータ | 説明 |
|---|---|
| -FilePath パス | 出力するファイルパスを指定する |
| -LiteralPath パス | 対象パスを指定する（ワイルドカード使用不可） （例）-LiteralPath "D:\test" |
| -Encoding 文字コード | 文字コードを指定する ・ascii ・bigendianunicode ・default ・oem ・string ・unicode ・unknown ・utf32 ・utf7 ・utf8 |
| -Append | 追記モードで出力する |
| -Force | 強制的に実行する |
| -NoClobber | 既存ファイルを上書きしない |
| -Width 文字数 | 出力行の最大文字数を指定する ※この文字数を超えた場合は切り捨てられる |
| -NoNewline | 最後に改行コードを出力しない |
| -InputObject オブジェクト | 出力するオブジェクトを指定する |
| -WhatIf | 実行はせずに実行結果の確認のみ行う |
| -Confirm | 実行前に確認メッセージの表示を行う |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
文字列"ABC"をテキストファイルにUTF-8、追記モードで出力する
$str = "ABC"
Out-File -FilePath "C:\sample.txt" -InputObject $str -Encoding UTF-8 -Append
C:\testフォルダ配下のリストをテキストファイルにUTF-8、追記モードで出力する
$list = Get-ChildItem -Path "D:\test"
Out-File -FilePath "C:\sample.txt" -InputObject $list -Encoding UTF-8 -Append
コマンドのヘルプを表示する
Get-Help Out-File
備考
- パラメータ名の「-FilePath」は省略可能です。
関連項目
- File系コマンドレット
- Out-File：オブジェクトをファイルに出力する
