Write-Host
カスタマイズした出力をホストに書き込みます。
構文
Write-Host
[[-Object] <Object>]
[-NoNewline]
[-Separator <Object>]
[-ForegroundColor <ConsoleColor>]
[-BackgroundColor <ConsoleColor>]
[<CommonParameters>]
説明
Write-Host
コマンドレットの主な目的は、for-(host)-display-only 出力を生成することです。たとえば、Read-Hostと組み合わせてユーザーに入力を求めるときに色付きのテキストを印刷するなどです。 Write-Host
は、 ToString() メソッドを使用して出力を書き込みます。 これに対し、パイプラインにデータを出力するには、 Write-Output または暗黙的な出力を使用します。
ForegroundColor
パラメーターを使用してテキストの色を指定したり、BackgroundColor
パラメーターを使用して背景色を指定したりできます。 Separator パラメーターを使用すると、個々の表示オブジェクトを区切るための文字列を指定できます。 特定の結果は、PowerShell をホストしているプログラムによって異なります。
Note
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=
(コンマ、スペース、+
、2
、=
、スペース) を追加するために使用されます。
例 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.
このコマンドは、"白いテキストに赤" という文字列を表示します。 ForegroundColor
パラメーターで定義されているように、テキストは赤です。 BackgroundColor
パラメーターで定義されているように、背景は白です。
例 5: 書き込みホストからの出力を抑制する
# 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
これらのコマンドは、 Write-Host
コマンドレットの出力を効果的に抑制します。 1 つ目は、Ignore
Value と共に InformationAction
パラメーターを使用して、情報ストリームへの出力を抑制します。
2 番目の例では、コマンドの情報ストリームを $null
変数にリダイレクトし、それを抑制します。 詳細については、「 about_Output_Streams」を参照してください。
パラメーター
-BackgroundColor
背景色を指定します。 既定値はありません。 このパラメーターの有効値は、次のとおりです。
Black
DarkBlue
DarkGreen
DarkCyan
DarkRed
DarkMagenta
DarkYellow
Gray
DarkGray
Blue
Green
Cyan
Red
Magenta
Yellow
White
型: | ConsoleColor |
指定可能な値: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ForegroundColor
文字の色を指定します。 既定値はありません。 このパラメーターの有効値は、次のとおりです。
Black
DarkBlue
DarkGreen
DarkCyan
DarkRed
DarkMagenta
DarkYellow
Gray
DarkGray
Blue
Green
Cyan
Red
Magenta
Yellow
White
型: | 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
このコマンドレットは、出力を返しません。 ホストにオブジェクトを送信します。 ホストは、このコマンドレットが送信するオブジェクトを表示します。
メモ
ホストにコレクションを書き込む場合、コレクションの要素は、1 つのスペースで区切られた同じ行に出力されます。 これは、 Separator パラメーターでオーバーライドできます。
プロパティを持つオブジェクトなどの非プリミティブ データ型は、予期しない結果を引き起こし、意味のある出力を提供しない可能性があります。 たとえば、
Write-Host @{a = 1; b = 2}
はホストにSystem.Collections.DictionaryEntry System.Collections.DictionaryEntry
を出力します。
関連リンク
PowerShell