Write-Host

  • 参考
模块:
Microsoft.PowerShell.Utility

将自定义的输出写入主机。

语法

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

说明

Write-Host cmdlet 的主要用途是生成 for-(host)-display-only 输出，例如提示用户与 Read-Host 一起输入时打印彩色文本等。 Write-Host 使用 ToString() 方法写入输出。 相比之下，若要将数据输出到管道，请使用 Write-Output 或隐式输出。

你可以使用 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= （逗号、空格、+、2、=、空格）。

示例 3：使用不同的文本和背景色进行写入

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

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

此命令显示从 2 到 12 的偶数。 它使用 ForegroundColor 参数来输出深绿色文本，并使用 BackgroundColor 参数来显示白色背景。

示例 4：使用不同的文本和背景色进行写入

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

Red on white text.

此命令显示字符串“Red on white text”。按照 ForegroundColor 参数的定义，文本将为红色。 按照 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

这些命令可有效抑制 Write-Host cmdlet 的输出。 第一个参数使用 InformationAction 参数和 Ignore 值来禁止输出到信息流。 第二个示例将命令的信息流重定向到 $null 变量，从而取消它。 有关详细信息，请参阅 about_Output_Streams。

参数

-BackgroundColor

指定背景色。 没有默认值。 此参数的可接受值为：

  • Black
  • DarkBlue
  • DarkGreen
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Gray
  • DarkGray
  • Blue
  • Green
  • Cyan
  • Red
  • Magenta
  • Yellow
  • White
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForegroundColor

指定文本颜色。 没有默认值。 此参数的可接受值为：

  • Black
  • DarkBlue
  • DarkGreen
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Gray
  • DarkGray
  • Blue
  • Green
  • Cyan
  • Red
  • Magenta
  • Yellow
  • White
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoNewline

输入对象的字符串表示形式串联形成输出。 输出字符串之间不插入空格或换行符。 最后一个输出字符串后面不添加换行符。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Object

要在主机中显示的对象。

Type:Object
Aliases:Msg, Message
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Separator

指定要在主机显示的对象之间插入的分隔符字符串。

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

Object

可以通过管道将要写入主机的对象传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。 它会将对象发送到主机。 主机显示此 cmdlet 发送给它的对象。

备注

  • 将集合写入主机时，集合的元素将打印在用单个空格分隔的同一行上。 可以使用 Separator 参数替代此参数。

  • 非基元数据类型（如具有属性的对象）可能会导致意外结果，并且不提供有意义的输出。 例如，Write-Host @{a = 1; b = 2} 会将 System.Collections.DictionaryEntry System.Collections.DictionaryEntry 打印到主机。