zapisuje niestandardowe wyjście do hosta.
składnia
opis
głównym celemWrite-Host cmdlet jest generowanie tylko dla-(host)-display-only danych wyjściowych, takich jak drukowanie kolorowego tekstu, jak podczas monitowania użytkownika o wejście w połączeniu z Read-Host.Write-Host używa metody ToString () do zapisu pliku wyjściowego., Dla kontrastu, aby wysłać dane do potoku, użyj Write-Output lub implicitoutput.
możesz określić kolor tekstu za pomocą parametru ForegroundColor, a kolor paska można określić za pomocą parametruBackgroundColor. Parametr Separator pozwala określićznak, którego można użyć do oddzielenia wyświetlanych obiektów. Konkretny wynik zależy od programu, który wyświetla PowerShell.
Uwaga
uruchamianie w Windows PowerShell 5.,0, Write-Host jest opakowaniem dla Write-Informationpozwala to na użycieWrite-Host do emitowania wyjścia do strumienia informacji. Umożliwia to przechwytywanie lub kompresję danych zapisanych przy użyciu Write-Host przy zachowaniu wstecznej kompatybilności.
zmienna preferencji$InformationPreference IInformationAction wspólny parametr nie wpływają na wiadomościWrite-Host. Wyjątkiem od tej reguły jest -InformationAction Ignore, co skutecznie blokuje wyjście Write-Host., (patrz „przykład 5”)
przykłady
przykład 1: zapis do konsoli bez dodawania nowej linii
To polecenie wyświetla ciąg znaków „no newline test” z parametrem NoNewline.
drugi ciąg jest zapisywany, ale kończy się w tej samej linii co pierwszy z powodu braku nowej linii oddzielającej ciągi.,
przykład 2: zapis do konsoli i dołączenie separatora
przykład 3: zapis z różnymi kolorami tekstu i tła
To polecenie wyświetla liczby parzyste od dwóch do dwunastu. Używa parametru ForegroundColordo wyświetlania ciemnozielonego tekstu oraz parametru BackgroundColor do wyświetlania białego pola.
przykład 4: zapis z różnymi kolorami tekstu i tła
To polecenie wyświetla ciąg znaków „czerwony na białym tekście.,”Tekst jest czerwony, zgodnie z parametremForegroundColor. Tło jest białe, zgodnie z parametrem BackgroundColor.
przykład 5: wyłącza wyjście z Write-Host
te polecenia skutecznie wyłączają wyjścieWrite-Host cmdlet. Pierwszy z nich używa parametruInformationAction z wartością Ignore do wyłączania wyjścia do strumienia informacji.,Drugi przykład przekierowuje strumień informacji polecenia do zmiennej $null I thereby ją zamyka.
parametry
określa kolor tła. Nie ma wartości domyślnej.,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., Nie ma wartości domyślnej.,
The string representations of the input objects are concatenated to form the output., Pomiędzy wyjściowymi ciągami nie są wstawiane spacje. Po ostatnim ciągu wyjściowym nie jest dodawany nowy wiersz.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | false |
| Akceptuj znaki wieloznaczne: | false |
obiekty do wyświetlenia na komputerze.,
| 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., Jednak host wyświetla obiekty, któreWrite-Host do niego wysyła.
Notes
-
podczas zapisywania zbioru do hosta, elementy zbioru są drukowane na tych samych liniach rozdzielonych pojedynczą spacją. Można to nadpisać parametrem Separator.
-
nie-prymitywne typy danych, takie jak obiekty z właściwościami, mogą powodować nieoczekiwane wyniki i nie zapewniać znaczących wyników. Na przykład
Write-Host @{a = 1; b = 2}wydrukujeSystem.Collections.DictionaryEntry System.Collections.DictionaryEntryna komputerze.,
- Clear-Host
- Out-Host
- Write-Debug
- write-Error
- Write-Output
- write-Progress
- Write-Verbose
- Write-Warning