共用方式為

Write-Host

  • 參考
模組:
Microsoft.PowerShell.Utility

將自訂輸出寫入主機。

語法

Write-Host
     [[-Object] <Object>]
     [-NoNewline]
     [-Separator <Object>]
     [-ForegroundColor <ConsoleColor>]
     [-BackgroundColor <ConsoleColor>]
     [<CommonParameters>]

Description

Write-Host Cmdlet 會自定義輸出。 您可以使用 ForegroundColor 參數來指定文字的色彩，而且您可以使用 BackgroundColor 參數來指定背景色彩。 Separator 參數可讓您指定要用來分隔顯示物件的字串。 特定結果取決於裝載 PowerShell 的程式。

注意

從 Windows PowerShell 5.0 開始，Write-Host 是 Write-Information 包裝函式。這可讓您使用 Write-Host 來發出資訊數據流的輸出。 這可讓 擷取 或 隱藏 使用 Write-Host 寫入的數據，同時保留回溯兼容性。

$InformationPreference 喜好設定變數和一般參數 InformationAction 不會影響 Write-Host 訊息。 此規則的例外狀況是 -InformationAction Ignore，這實際上會隱藏 Write-Host 輸出。 （請參閱“範例 5”）

範例

範例 1：寫入主控台而不新增新行

Write-Host "no newline test " -NoNewline
Write-Host "second string"

no newline test second string

此命令會以 NoNewline 參數顯示字串 『no newline test』。

第二個字串會寫入，但最後會以與第一行相同，因為沒有分隔字串的新行。

範例 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= (comma, space, +, 2, =, space)。

範例 3：使用不同的文字和背景色彩撰寫

Write-Host (2,4,6,8,10,12) -Separator ", -> " -ForegroundColor DarkGreen -BackgroundColor White

2, -> 4, -> 6, -> 8, -> 10, -> 12

此命令會顯示從 2 到 12 的偶數。 它會使用 ForegroundColor 參數來輸出 『深綠色』 文字，並使用 BackgroundColor 參數來顯示 『white』 背景。

範例 4：使用不同的文字和背景色彩撰寫

Write-Host "Red on white text." -ForegroundColor red -BackgroundColor white

Red on white text.

此命令會顯示字串「白色文字上的紅色」。文字為 'red'，如 ForegroundColor 參數所定義。 背景為 『white』，如 BackgroundColor 參數所定義。

範例 5：隱藏來自 Write-Host 的輸出

# 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

此命令會顯示字串「白色文字上的紅色」。文字為 'red'，如 ForegroundColor 參數所定義。 背景為 『white』，如 BackgroundColor 參數所定義。

參數

-BackgroundColor

指定背景色彩。 沒有預設值。 此參數可接受的值為：

  • 黑
  • 深藍
  • 深綠
  • 深青色
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • 灰色
  • DarkGray
  • 藍
  • 綠
  • 青色
  • 紅
  • 品紅
  • 黃色
  • 白
類型:ConsoleColor
接受的值:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ForegroundColor

指定文字色彩。 沒有預設值。 此參數可接受的值為：

  • 黑
  • 深藍
  • 深綠
  • 深青色
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • 灰色
  • DarkGray
  • 藍
  • 綠
  • 青色
  • 紅
  • 品紅
  • 黃色
  • 白
類型:ConsoleColor
接受的值:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-NoNewline

輸入物件的字串表示會串連以形成輸出。 輸出字串之間不會插入空格或換行符。 最後一個輸出字串之後不會新增任何換行符。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Object

要顯示在主機中的物件。

類型:Object
Position:0
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Separator

指定要在主機所顯示物件之間插入的分隔符字串。

類型:Object
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

輸入

Object

您可以使用管線將物件寫入主機。

輸出

None

Write-Host 將對象傳送至主機。 它不會傳回任何物件。 不過，主機可能會顯示 Write-Host 傳送給它的物件。