Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Write-Host

Write-Host

microsoft.powershell.commands.utility.dll

Synopsis

Writes customized output to a host.

Syntax

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

Detailed Description

The Write-Host cmdlet customizes output. You can specify the color of text by using the ForegroundColor parameter, and you can specify the background color by using the BackgroundColor parameter. The Separator parameter lets you specify a string to use to separate displayed objects. The particular result depends on the program that is hosting Windows PowerShell.

Parameters

-BackgroundColor <ConsoleColor>

Specifies the background color. There is no default.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ForegroundColor <ConsoleColor>

Specifies the text color. There is no default.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NoNewline <SwitchParameter>

Specifies that the content displayed in the console does not end with a newline character.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Object <Object>

Objects to display in the console.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Separator <Object>

String to the output between objects displayed on the console.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

System.Object

Return Type

None

Notes

None

Examples

-------------------------- EXAMPLE 1 --------------------------

This command displays the input to the console, but because of the NoNewline parameter, the output is followed directly by the prompt.

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

-------------------------- EXAMPLE 2 --------------------------

This command displays the even numbers from 2 through 12. The Separator parameter is used to add the string , +2= (comma, space, +, 2, =, space).

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

-------------------------- EXAMPLE 3 --------------------------

This command displays the even numbers from 2 through 12. It uses the ForegroundColor parameter to output dark green text and the BackgroundColor parameter to display a white background.

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

-------------------------- EXAMPLE 4 --------------------------

This command displays the string "Red on white text." The text is red, as defined by the ForegroundColor parameter. The background is white, as defined by the BackgroundColor parameter.

PS C:\>write-host "Red on white text." -ForegroundColor red -BackgroundColor white
Red on white text.

Online Version
Clear-Host
Out-Host
Write-Debug
Write-Error
Write-Output
Write-Progress
Write-Verbose
Write-Warning