Write-Host

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

Het primaire doel van de Write-Host cmdlet is het produceren van alleen-(host)-weergave-uitvoer, zoals het afdrukken van gekleurde tekst, zoals wanneer de gebruiker wordt gevraagd om invoer in combinatie met Read-Host-. Write-Host gebruikt de methode ToString() om de uitvoer te schrijven. Als u daarentegen gegevens naar de pijplijn wilt uitvoeren, gebruikt u write-output of impliciete uitvoer.

U kunt de kleur van tekst opgeven met behulp van de parameter ForegroundColor en u kunt de achtergrondkleur opgeven met behulp van de parameter BackgroundColor. Met de parameter Scheidingsteken kunt u een tekenreeks opgeven die moet worden gebruikt om weergegeven objecten te scheiden. Het specifieke resultaat is afhankelijk van het programma dat als host fungeert voor PowerShell.

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

no newline test second string

Met deze opdracht wordt de tekenreeks 'geen nieuwelijntest' weergegeven met de parameter NoNewline.

Een tweede tekenreeks wordt geschreven, maar eindigt op dezelfde regel als de eerste vanwege het ontbreken van een nieuwe regel tussen de tekenreeksen.

Write-Host (2,4,6,8,10,12) -Separator ", +2= "

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

Met deze opdracht worden de even getallen van twee tot en met twaalf weergegeven. De parameter Scheidingsteken wordt gebruikt om de tekenreeks toe te voegen , +2= (komma, spatie, +, 2, =, spatie).

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

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

Met deze opdracht worden de even getallen van twee tot en met twaalf weergegeven. De parameter ForegroundColor wordt gebruikt om donkergroene tekst uit te voeren en de parameter BackgroundColor om een witte achtergrond weer te geven.

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

Red on white text.

Met deze opdracht wordt de tekenreeks 'Rood op witte tekst' weergegeven. De tekst is rood, zoals gedefinieerd door de parameter ForegroundColor. De achtergrond is wit, zoals gedefinieerd door de parameter BackgroundColor.

# 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

Met deze opdrachten wordt de uitvoer van de Write-Host cmdlet effectief onderdrukt. De eerste gebruikt de parameter InformationAction met de Ignore-waarde om uitvoer naar de informatiestroom te onderdrukken. In het tweede voorbeeld wordt de informatiestroom van de opdracht omgeleid naar de $null variabele en wordt deze hierdoor onderdrukt. Zie about_Output_Streamsvoor meer informatie.

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

U kunt objecten doorsluisen die naar de host naar deze cmdlet moeten worden geschreven.

Deze cmdlet retourneert geen uitvoer. De objecten worden naar de host verzonden. De host geeft de objecten weer die door deze cmdlet worden verzonden.

• Bij het schrijven van een verzameling naar de host worden elementen van de verzameling afgedrukt op dezelfde regel, gescheiden door één spatie. Dit kan worden overschreven met de parameter Scheidingsteken.

• Niet-primitieve gegevenstypen, zoals objecten met eigenschappen, kunnen onverwachte resultaten veroorzaken en geen zinvolle uitvoer bieden. Write-Host @{a = 1; b = 2} drukt bijvoorbeeld System.Collections.DictionaryEntry System.Collections.DictionaryEntry af op de host.