Write-Host
Hiermee schrijft u aangepaste uitvoer naar een host.
Syntaxis
Write-Host
[[-Object] <Object>]
[-NoNewline]
[-Separator <Object>]
[-ForegroundColor <ConsoleColor>]
[-BackgroundColor <ConsoleColor>]
[<CommonParameters>]
Description
De Write-Host
-cmdlet past uitvoer aan.
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.
Notitie
Vanaf Windows PowerShell 5.0 is Write-Host
een wrapper voor Write-Information
Hiermee kunt u Write-Host
gebruiken om uitvoer naar de informatiestroom te verzenden.
Hierdoor kan de of onderdrukking gegevens vastleggen die zijn geschreven met behulp van Write-Host
, terwijl achterwaartse compatibiliteit behouden blijft.
De $InformationPreference
voorkeursvariabele en InformationAction
algemene parameter hebben geen invloed op Write-Host
berichten.
De uitzondering op deze regel is -InformationAction Ignore
, waardoor Write-Host
uitvoer effectief wordt onderdrukt. (zie 'Voorbeeld 5')
Voorbeelden
Voorbeeld 1: Schrijven naar de console zonder een nieuwe regel toe te voegen
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.
Voorbeeld 2: Schrijven naar de console en een scheidingsteken opnemen
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= (comma, space, +, 2, =, space)
.
Voorbeeld 3: Schrijven met verschillende tekst- en achtergrondkleuren
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 en de parameter BackgroundColor
uit te voeren om een 'witte' achtergrond weer te geven.
Voorbeeld 4: Schrijven met verschillende tekst- en achtergrondkleuren
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
.
Voorbeeld 5: Uitvoer van Write-Host onderdrukken
# 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 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
.
Parameters
-BackgroundColor
Hiermee geeft u de achtergrondkleur op. Er is geen standaardinstelling. De acceptabele waarden voor deze parameter zijn:
- Zwart
- DarkBlue
- DarkGreen
- DarkCyan
- Donkerrood
- DarkMagenta
- DarkYellow
- Grijs
- DarkGray
- Blauw
- Groen
- Cyaan
- Rood
- Magenta
- Geel
- Wit
Type: | ConsoleColor |
Geaccepteerde waarden: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | False |
Jokertekens accepteren: | False |
-ForegroundColor
Hiermee geeft u de tekstkleur op. Er is geen standaardinstelling. De acceptabele waarden voor deze parameter zijn:
- Zwart
- DarkBlue
- DarkGreen
- DarkCyan
- Donkerrood
- DarkMagenta
- DarkYellow
- Grijs
- DarkGray
- Blauw
- Groen
- Cyaan
- Rood
- Magenta
- Geel
- Wit
Type: | ConsoleColor |
Geaccepteerde waarden: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | False |
Jokertekens accepteren: | False |
-NoNewline
De tekenreeksweergaven van de invoerobjecten worden samengevoegd om de uitvoer te vormen. Er worden geen spaties of nieuwe regels ingevoegd tussen de uitvoertekenreeksen. Er wordt geen nieuwe regel toegevoegd na de laatste uitvoertekenreeks.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | False |
Jokertekens accepteren: | False |
-Object
Objecten die in de host moeten worden weergegeven.
Type: | Object |
Position: | 0 |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | True |
Jokertekens accepteren: | False |
-Separator
Hiermee geeft u een scheidingstekenreeks op die moet worden ingevoegd tussen objecten die door de host worden weergegeven.
Type: | Object |
Position: | Named |
Default value: | None |
Vereist: | False |
Pijplijninvoer accepteren: | False |
Jokertekens accepteren: | False |
Invoerwaarden
U kunt objecten doorsluisen die naar de host moeten worden geschreven.
Uitvoerwaarden
None
Write-Host
de objecten naar de host verzendt.
Er worden geen objecten geretourneerd.
De host kan echter wel de objecten weergeven die Write-Host
naar de host verzendt.