カスタマイズされた出力をホストに書き込みます。

構文

Write-Host [[-Object] <Object>] [-BackgroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-ForegroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-NoNewline] [-Separator <Object>] [<CommonParameters>]

説明

Write-Host コマンドレットは、出力をカスタマイズします。ForegroundColor パラメーターを使用して、テキストの色を指定できます。また、BackgroundColor パラメーターを使用して、背景色を指定できます。Separator パラメーターを使用すると、表示オブジェクトを区切るための文字列を指定できます。具体的な結果は、Windows PowerShell をホストしているプログラムによって異なります。

パラメーター

-BackgroundColor <ConsoleColor>

背景色を指定します。既定値はありません。

必須

false

位置

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ForegroundColor <ConsoleColor>

テキストの色を指定します。既定値はありません。

必須

false

位置

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-NoNewline

コンソールに表示されるコンテンツの最後に改行文字を使用しないことを指定します。

必須

false

位置

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Object <Object>

コンソールに表示するオブジェクト。

必須

false

位置

1

既定値

なし

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

-Separator <Object>

コンソールに表示されるオブジェクトとオブジェクトの間に出力する文字列。

必須

false

位置

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

System.Object

パイプを使用して、書き込むオブジェクトをホストに渡すことができます。

出力

なし

Write-Host は、オブジェクトをホストに渡します。このコマンドレットはオブジェクトを返しません。ただし、Write-Host から渡されたオブジェクトをホストが表示する場合があります。

例 1

C:\PS>write-host "no newline test " -nonewline

no newline test C:\PS>

説明
-----------
このコマンドは入力をコンソールに表示しますが、NoNewline パラメーターが指定されているため、出力の直後にプロンプトが続いて表示されます。

例 2

C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= "

2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12

説明
-----------
このコマンドは、2 ～ 12 の範囲の偶数を表示します。", +2= " (コンマ、スペース、+、2、=、スペース) という文字列を追加するため、Separator パラメーターが使用されています。

例 3

C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGreen -backgroundcolor white

説明
-----------
このコマンドは、2 ～ 12 の範囲の偶数を表示します。ForegroundColor パラメーターを使用してテキストを濃い緑色で出力し、BackgroundColor パラメーターを使用して背景を白で表示します。

例 4

C:\PS>write-host "Red on white text." -ForegroundColor red -BackgroundColor white

Red on white text.

説明
-----------
このコマンドを実行すると、"Red on white text" という文字列が表示されます。ForegroundColor パラメーターで定義されたとおり、テキストは赤です。BackgroundColor パラメーターで定義されたとおり、背景は白です。

関連項目



目次