カスタマイズされた出力をホストに書き込みます。
構文
説明
Write-Hostコマンドレットの主な目的は、Read-Hostと組み合わせてユーザーに入力を求めるときのような色付きのテキストを印刷するなど、for-(host)-display-only出力を生成することです。Write-HostToString()メソッドを使用して出力を書き込みます。, これに対して、パイプラインにデータを出力するには、Write-Outputまたはimplicitoutputを使用します。
ForegroundColorパラメータを使用してテキストの色を指定し、BackgroundColorパラメータを使用して背景色を指定できます。 セパレータのパラメーター specifya使用する文字列を別途表示されます。 特定の結果は、PowerShellをホストするプログラムによって異なります。
メモ
Windows PowerShell5以降です。,0,Write-HostのラッパーですWrite-Informationこれにより、Write-Hostを使用して情報ストリームに出力を出力することができます。 これにより、下位互換性を維持しながら、Write-Hostを使用して書き込まれたデータのキャプチャまたはサプレッションが可能になります。
$InformationPreferenceプリファレンス変数およびInformationAction共通パラメータはWrite-Hostメッセージに影響を与えません。 このルールの例外は、-InformationAction Ignoreであり、Write-Host出力を効果的に抑制します。, (“例5″を参照)
例
例1:新しい行を追加せずにコンソールに書き込みます
このコマンドは、NoNewlineパラメーターを持つ文字列”no newline test”を表示します。
第二の文字列が書き込まれますが、文字列を区切る新しい行がないため、最初の文字列と同じ行になります。,
例2:コンソールに書き込み、区切り文字を含めます
例3:異なるテキストと背景色で書き込みます
このコマンドは、二から十二 これは、ForegroundColorパラメーターを使用して濃い緑色のテキストを出力し、BackgroundColorパラメーターを使用してwhitebackgroundを表示します。
例4:異なるテキストと背景色で書き込みます
このコマンドは、文字列”白いテキストに赤を表示します。,”テキストは、ForegroundColorパラメータで定義されているように、赤です。 背景は、BackgroundColorパラメーターで定義されているように、白です。
例5:Write-Hostからの出力を抑制
これらのコマンドは、Write-Hostコマンドレットの出力を効果的に抑制します。 最初のものは、InformationActionパラメータとIgnore値を使用して、情報ストリームへの出力を抑制します。,次の例では、コマンドの情報ストリームを$null変数にリダイレクトし、therebyはそれを抑制します。
パラメータ
背景色を指定します。 デフォルトはありません。,ellow
| Type: | ConsoleColor |
| Accepted values: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the text color., デフォルトはありません。,
The string representations of the input objects are concatenated to form the output., 出力文字列の間にスペースまたは改行は挿入されません。 最後の出力文字列の後に改行は追加されません。
| タイプ: | スイッチパラメータ |
| 位置: | 名前付き |
| デフォルト値: | なし |
| パイプライン入力を受け入れます: | False |
| ワイルドカード文字を受け入れます。 | false |
ホストに表示するオブジェクト。,
| Type: | Object |
| Aliases: | Msg, Message |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Specifies a separator string to insert between objects displayed by the host.,
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Object
You can pipe objects to be written to the host.
Outputs
None
Write-Host sends the objects to the host. It does not return any objects., ただし、ホストはWrite-Hostが送信するオブジェクトを表示します。
Notes
-
コレクションをホストに書き込むとき、コレクションの要素は単一のスペースで区切られた同じ行に印刷されます。 これはSeparatorパラメーターで上書きできます。
-
プロパティを持つオブジェクトなどの非プリミティブデータ型は、予期しない結果を引き起こし、意味のある出力を提供しない可能性があります。 たとえば、
Write-Host @{a = 1; b = 2}はSystem.Collections.DictionaryEntry System.Collections.DictionaryEntryをホストに出力します。,
- クリアホスト
- アウトホスト
- 書き込みデバッグ
- 書き込みエラー
- 書き込み出力
- 書き込みプログレス
- 書き込み詳細
- 書き込み警告