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 をホストしているプログラムによって異なります。

例

例 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

-ForegroundColor

-NoNewline

-Object

-Separator

入力

Object

ホストに書き込まれるオブジェクトをこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。 ホストにオブジェクトを送信します。 ホストは、このコマンドレットが送信するオブジェクトを表示します。

メモ

• ホストにコレクションを書き込む場合、コレクションの要素は、1 つのスペースで区切られた同じ行に出力されます。 これは、 Separator パラメーターでオーバーライドできます。

• プロパティを持つオブジェクトなどの非プリミティブ データ型は、予期しない結果を引き起こし、意味のある出力を提供しない可能性があります。 たとえば、 Write-Host @{a = 1; b = 2} はホストに System.Collections.DictionaryEntry System.Collections.DictionaryEntry を出力します。

関連リンク

• Clear-Host
• Out-Host
• Write-Debug
• Write-Error
• Write-Output
• Write-Progress
• Write-Verbose
• Write-Warning