Schreibt angepasste Ausgabe auf einen Host.
Syntax
Beschreibung
Der Hauptzweck des Write-Host Cmdlets besteht darin, eine for-(host)-Display-Only-Ausgabe zu erzeugen, Zdruck von farbigem Text wie beim Auffordern des Benutzers zur Eingabe in Verbindung mit Read-Host.Write-Host verwendet die toString () – Methode, um theoutput zu schreiben., Verwenden Sie dagegen Write-Output oder implicitoutput, um Daten an die Pipeline auszugeben.
Sie können die Farbe des Textes mithilfe des Parameters ForegroundColor und die Hintergrundfarbe mithilfe des Parameters BackgroundColor angeben. Mit dem Parameter Separator können Sie eine Zeichenfolge angeben, die zum Trennen angezeigter Objekte verwendet werden soll. Das besondere Ergebnis hängt von dem Programm ab, das isthosting PowerShell.
Hinweis
Ab Windows PowerShell 5.,0, Write-Host ist ein wrapper für Write-Information Dies ermöglichtSie verwenden Write-Host zu emittieren ausgang zu die informationen stream. Dies ermöglicht die Erfassung oder Komprimierung von Daten, die mit Write-Host geschrieben wurden, unter Beibehaltung der Abwärtskompatibilität.
Die$InformationPreference preference variable undInformationAction gemeinsame Parameter nichtbeeinflussenWrite-Host Nachrichten. Die Ausnahme von dieser Regel ist -InformationAction Ignore, dieeffektiv unterdrückt Write-Host Ausgabe., (siehe „Beispiel 5“)
Beispiele
Beispiel 1: Schreiben Sie in die Konsole, ohne eine neue Zeile hinzuzufügen
Dieser Befehl zeigt die Zeichenfolge „no newline test“ mit dem Parameter NoNewline an.
Eine zweite Zeichenfolge wird geschrieben, aber sie endet in derselben Zeile wie die erste, da keine neue Zeile die Zeichenfolgen trennt.,
Beispiel 2: Schreiben Sie in die Konsole und fügen Sie ein Trennzeichen ein
Beispiel 3: Schreiben Sie mit verschiedenen Text-und Hintergrundfarben
Dieser Befehl zeigt die geraden Zahlen von zwei bis zwölf an. Es verwendet den Parameter ForegroundColorzur Ausgabe von dunkelgrünem Text und den Parameter BackgroundColor zur Anzeige eines Whitebackground.
Beispiel 4: Schreiben Sie mit verschiedenen Text-und Hintergrundfarben
Dieser Befehl zeigt die Zeichenfolge “ Rot auf weißem Text.,“Der Text ist rot, wie durch den ParameterForegroundColor definiert. Der Hintergrund ist weiß, wie durch den Parameter BackgroundColordefiniert.
Beispiel 5: Ausgabe vom Write-Host unterdrücken
Diese Befehle unterdrücken effektiv die Ausgabe des Cmdlets Write-Host. Der erste verwendet den ParameterInformationAction mit dem Wert Ignore, um die Ausgabe in den Informationsstrom zu unterdrücken.,Das zweite Beispiel leitet den Informationsstrom des Befehls an die Variable $null weiter und unterdrückt ihn dann.
Parameter
Gibt die Hintergrundfarbe an. Es gibt keinen Standard.,ellow
| Type: | ConsoleColor |
| Accepted values: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the text color., Es gibt keinen Standard.,
The string representations of the input objects are concatenated to form the output., Zwischen den Ausgabezeichenfolgen werden keine Leerzeichen oder Zeilenumbrüche eingefügt. Nach der letzten Ausgabezeichenfolge wird keine neue Zeile hinzugefügt.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Platzhalterzeichen akzeptieren: | False |
Objekte, die im Host angezeigt werden sollen.,
| Type: | Object |
| Aliases: | Msg, Message |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Specifies a separator string to insert between objects displayed by the host.,
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Object
You can pipe objects to be written to the host.
Outputs
None
Write-Host sends the objects to the host. It does not return any objects., Der hostdisplays jedoch die Objekte, die Write-Host an ihn sendet.
Hinweise
-
Beim Schreiben einer Sammlung auf den Host werden Elemente der Sammlung auf denselben Zeilengezeichnet, die durch ein einzelnes Leerzeichen getrennt sind. Dies kann mit dem Parameter Separator überschrieben werden.
-
Nicht-primitive Datentypen wie Objekte mit Eigenschaften können zu unerwarteten Ergebnissen führen und keine aussagekräftige Ausgabe liefern. Beispiel:
Write-Host @{a = 1; b = 2}drucktSystem.Collections.DictionaryEntry System.Collections.DictionaryEntryauf den Host.,
- Clear-Host
- Out-Host
- Write-Debug
- Write-Error
- Write-Output
- Write-Progress
- Write-Verbose
- Write-Warning