Write-host 帮助信息

如下说明是翻译: help write-host 产生的帮助信息.

译者: Edengundam(马涛)

 

Write-Host

 

大纲

使用host用户接口显示输入对象

 

语法

Write-Host [[-object] <Object>] [-noNewLine] [-separator <Object>] [-foregroundcolor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-backgroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [<CommonParameters>]

 

详细描述

使用host用户接口显示输入对象. Write-Host创建一个自定义的host窗口. 你可以通过ForegroundColor参数指定现在该窗口中文本的颜色, 也可以通过BackgroundColor 参数指定显示在该窗口中本文的背景颜色. 分隔符参数允许指定特定字符串, 作为不同对象之间的分隔符.

 

参数

 

-object <Object>

要显示在控制台上的对象.

 

强制参数?	false
参数位置?	1
默认值
允许从管道绑定输入?	true (传值)
允许通配符扩展?	false

 

-noNewLine <SwitchParameter>

指定显示在控制台的信息不以换行结尾.

 

强制参数?	false
参数位置?	named
默认值	False
允许从管道绑定输入?	false
允许通配符扩展?	false

 

-separator <Object>

指定显示在控制台上的对象之间使用的分隔字符串.

 

强制参数?	false
参数位置?	named
默认值	一个空格
允许从管道绑定输入?	false
允许通配符扩展?	false

 

-foregroundcolor <ConsoleColor>

指定文本颜色.

 

此参数接受的取值如下:

 

·         Black

·         DarkBlue

·         DarkGreen

·         DarkCyan

·         DarkRed

·         DarkMagenta

·         DarkYellow

·         Gray

·         DarkGray

·         Blue

·         Green

·         Cyan

·         Red

·         Magenta

·         Yellow

·         White

 

强制参数?	false
参数位置?	named
默认值	Host-defined
允许从管道绑定输入?	false
允许通配符扩展?	false

 

-backgroundColor <ConsoleColor>

指定背景颜色.

 

此参数接受的取值如下:

 

·         Black

·         DarkBlue

·         DarkGreen

·         DarkCyan

·         DarkRed

·         DarkMagenta

·         DarkYellow

·         Gray

·         DarkGray

·         Blue

·         Green

·         Cyan

·         Red

·         Magenta

·         Yellow

·         White

 

强制参数?	false
参数位置?	named
默认值	Host-defined
允许从管道绑定输入?	false
允许通配符扩展?	false

 

<公共参数>

此命令支持公共参数: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. 更多信息, 输入, "get-help about_commonparameters".

 

输入类型

任意

 

注意

 

更多信息, 输入"Get-Help Write-Host -detailed".需要技术信息, 输入"Get-Help Write-Host -full".

 

如果需要为该命令提供多个参数, 请使用逗号进行分隔. 例如, "<parameter-name> <value1>, <value2>".

 

例1

 

C:/PS>write-host "no newline test" -nonewline

 

此命令显示输入信息到控制台, 由于制定了nonewline参数, 提示符直接跟在输出信息之后.

 

例2

 

C:/PS>write-host (2,4,6,8,10,12) -Separator ", +2= "

 

此命令显示从2到12的所有偶数. 分隔符参数指定使用 , +2= (逗号, 空格, +, 2, =, 空格)作为分割.

 

2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12

 

例3

 

C:/PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGreen -backgroundcolor white

 

此命令显示从2到12的所有偶数. Foregroundcolor参数指定输出文本为绿色, Backgroundcolor参数指定背景色为白色.

 

相关链接

Write-Verbose

Write-Error

Write-Progress

Write-Debug

Write-Output

Write-Warning

Out-Host