HOME > Host系コマンドレット > Write-Host
Write-Host
Write-Hostは、コンソールに文字列を出力するコマンドです。
エイリアスなし
解説
コンソールへ文字列などのオブジェクトを出力します。
文字列以外にも配列や連想配列などのオブジェクトも指定可能です。
構文
- （構文）
- Write-Host [[-Object] <Object>] [<CommonParameters>]
| パラメータ | 説明 |
|---|---|
| -Object 値 | 出力する対象を指定する |
| -NoNewline | 最後に改行を出力しない |
| -Separator 文字列 | 区切り文字を指定する |
| -ForegroundColor 色値 | 文字色を指定する ・Black ・Blue ・Cyan ・Gray ・Green ・Magenda ・Red ・White ・Yellow ・DarkBlue ・DarkCyan ・DarkGray ・DarkGreen ・DarkMagenta ・DarkRed ・DarkYellow |
| -BackgroundColor 色値 | 背景色を指定する ※指定できる色はForegroundColorと同じ |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
変数xを123で定義してコンソールに表示する
$x = 123
Write-Host -Object $x
パラメータ名「-Object」は省略可能です。
コンソールにabcと表示する
Write-Host -Object "abc"
abc
パラメータ名「-Object」は省略可能です。
変数の値を埋め込んで表示する
$a = 123
Write-Host "aの値は[$a]です。"
⇒aの値は[123]です。
配列の中身を、コロン区切りで表示する
Write-Host -Object @("AA", "BB", "CC") -Separator ":"
AA:BB:CC
コンソールにabcと黄色で表示する
Write-Host -Object "ABC" -ForegroundColor Yellow
ABC
変数aの内容を表示する
$a = 123
Write-Host ("変数a={0}" -f $a)
変数a=123
コマンドのヘルプを表示する
Get-Help Write-Host
備考
- パラメータ名「-Object」は省略可能です。
関連項目
- Host系コマンドレット
- Write-Host：コンソールに文字列を出力する
- Clear-Host：コンソールをクリアする
- Get-Host：ホストオブジェクトを取得する
- Out-Host：オブジェクトをコンソールに出力する
- Read-Host：入力文字列を読み取る
