將自訂輸出寫入主控程式。
語法
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 Cmdlet 會自訂輸出。您可以使用 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>
這個 Cmdlet 支援一般參數：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊，請參閱 about_Commonparameters.
輸入和輸出
輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。
|
輸入 |
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 的偶數。Separator 參數用來加入字串：, +2= (逗號、空格、+、2、=、空格)。
範例 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 參數所定義。
請參閱