Write-Host
カスタマイズされた出力をホストに書き込みます。
構文
Write-Host
[[-Object] <Object>]
[-NoNewline]
[-Separator <Object>]
[-ForegroundColor <ConsoleColor>]
[-BackgroundColor <ConsoleColor>]
[<CommonParameters>]説明
Write-Host コマンドレットは、出力をカスタマイズします。
ForegroundColor パラメーターを使用してテキストの色を指定したり、BackgroundColor パラメーターを使用して背景色を指定したりできます。
Separator パラメーターを使用すると、表示されるオブジェクトを区切るために使用する文字列を指定できます。
特定の結果は、PowerShell をホストしているプログラムによって異なります。
注
Windows PowerShell 5.0 以降では、Write-Host は Write-Information のラッパーです。これにより、Write-Host を使用して情報ストリームに出力を出力できます。
これにより、下位互換性を維持しながら、 を使用して書き込まれたデータの または Write-Host をキャプチャできます。
$InformationPreference 優先変数と共通パラメーター InformationAction、Write-Host メッセージには影響しません。
この規則の例外は -InformationAction Ignoreであり、出力 Write-Host 効果的に抑制されます。 (「例 5」を参照)
例
例 1: 新しい行を追加せずにコンソールに書き込む
Write-Host "no newline test " -NoNewline
Write-Host "second string"
no newline test second stringこのコマンドは、文字列 'no newline test' を NoNewline パラメーターと共に表示します。
2 番目の文字列が書き込まれますが、文字列を区切る改行がないため、1 行目と同じ行になります。
例 2: コンソールに書き込み、区切り記号を含める
Write-Host (2,4,6,8,10,12) -Separator ", +2= "
2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12このコマンドは、2 から 12 までの偶数を表示します。
Separator パラメーターは、文字列 の , +2= (comma, space, +, 2, =, space) を追加するために使用されます。
例 3: 異なるテキストと背景色で書き込む
Write-Host (2,4,6,8,10,12) -Separator ", -> " -ForegroundColor DarkGreen -BackgroundColor White
2, -> 4, -> 6, -> 8, -> 10, -> 12このコマンドは、2 から 12 までの偶数を表示します。
ForegroundColor パラメータを使用して '濃い緑' のテキストを出力し、BackgroundColor パラメータを使用して '白' の背景を表示します。
例 4: 異なるテキストと背景色で書き込む
Write-Host "Red on white text." -ForegroundColor red -BackgroundColor white
Red on white text.このコマンドは、文字列 "Red on white text" を表示します。テキストは、 ForegroundColor パラメーターで定義されているように 'red' です。
背景は、 BackgroundColor パラメーターで定義されているように '白' です。
例 5: Write-Host からの出力を抑制する
# The following two statements can be used to effectively suppress output from Write-Host
Write-Host "I won't print" -InformationAction Ignore
Write-Host "I won't print" 6>$null
このコマンドは、文字列 "Red on white text" を表示します。テキストは、 ForegroundColor パラメーターで定義されているように 'red' です。
背景は、 BackgroundColor パラメーターで定義されているように '白' です。
パラメーター
-BackgroundColor
背景色を指定します。 既定値はありません。 このパラメーターに使用できる値は次のとおりです。
- 黒い
- ダークブルー
- ダークグリーン
- ダークシアン (DarkCyan)
- ダークレッド
- ダークマゼンタ
- ダークイエロー
- 灰色
- ダークグレー
- 青い
- 緑色
- シアン
- 赤い
- マジェンタ
- 黄色
- 白い
| 型: | ConsoleColor |
| 指定可能な値: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ForegroundColor
テキストの色を指定します。 既定値はありません。 このパラメーターに使用できる値は次のとおりです。
- 黒い
- ダークブルー
- ダークグリーン
- ダークシアン (DarkCyan)
- ダークレッド
- ダークマゼンタ
- ダークイエロー
- 灰色
- ダークグレー
- 青い
- 緑色
- シアン
- 赤い
- マジェンタ
- 黄色
- 白い
| 型: | ConsoleColor |
| 指定可能な値: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-NoNewline
入力オブジェクトの文字列形式が連結されて出力が形成されます。 出力文字列の間にスペースや改行は挿入されません。 最後の出力文字列の後に改行は追加されません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Object
ホストに表示するオブジェクト。
| 型: | Object |
| 配置: | 0 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Separator
ホストによって表示されるオブジェクト間に挿入する区切り文字列を指定します。
| 型: | Object |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
ホストに書き込むオブジェクトをパイプできます。
出力
None
Write-Host オブジェクトをホストに送信します。
オブジェクトは返されません。
ただし、ホストは、 Write-Host がホストに送信するオブジェクトを表示する場合があります。