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

语法

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

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

输出

None

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 参数定义。






另请参阅




目录