Udostępnij za pomocą

Write-Host

Moduł:
Microsoft.PowerShell.Utility Module

Zapisuje dostosowane dane wyjściowe na hoście.

Składnia

Default (domyślnie) 

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

Opis

Polecenie cmdlet Write-Host dostosowuje dane wyjściowe. Kolor tekstu można określić przy użyciu parametru ForegroundColor, a kolor tła można określić przy użyciu parametru BackgroundColor. Parametr Separator umożliwia określenie ciągu, który ma być używany do oddzielania wyświetlanych obiektów. Konkretny wynik zależy od programu, który hostuje program PowerShell.

Uwaga / Notatka

Począwszy od programu Windows PowerShell 5.0, Write-Host jest obudową dla Write-Information. Umożliwia to użycie Write-Host do przekazywania danych wyjściowych do strumienia informacji. Umożliwia to przechwytywanie lub pomijanie danych zapisywanych przy użyciu Write-Host przy zachowaniu zgodności z poprzednimi wersjami.

Zmienna preferencji $InformationPreference i wspólny parametr InformationAction nie mają wpływu na komunikaty Write-Host. Wyjątkiem od tej reguły jest -InformationAction Ignore, co skutecznie pomija Write-Host danych wyjściowych. (zobacz "Przykład 5")

Przykłady

Przykład 1: Zapisywanie w konsoli bez dodawania nowego wiersza

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

no newline test second string

To polecenie wyświetla ciąg "no newline test" z parametrem NoNewline.

Drugi ciąg jest zapisywany, ale kończy się na tym samym wierszu co pierwszy ze względu na brak nowego wiersza oddzielającego ciągi.

Przykład 2. Zapisywanie w konsoli i dołączanie separatora

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

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

To polecenie wyświetla liczby parzyse z dwóch do dwunastu. Parametr Separator służy do dodawania ciągu , +2= (comma, space, +, 2, =, space).

Przykład 3. Zapisywanie przy użyciu różnych kolorów tekstu i tła

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

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

To polecenie wyświetla liczby parzyse z dwóch do dwunastu. Używa parametru ForegroundColor, aby wyświetlić tekst "ciemnozielony" i parametr BackgroundColor, aby wyświetlić tło "białe".

Przykład 4. Zapisywanie przy użyciu różnych kolorów tekstu i tła

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

Red on white text.

To polecenie wyświetla ciąg "Czerwony w białym tekście". Tekst jest "czerwony", zgodnie z definicją parametru ForegroundColor. Tło jest "białe", zgodnie z definicją parametru BackgroundColor.

Przykład 5. Pomijanie danych wyjściowych z Write-Host

# 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

To polecenie wyświetla ciąg "Czerwony w białym tekście". Tekst jest "czerwony", zgodnie z definicją parametru ForegroundColor. Tło jest "białe", zgodnie z definicją parametru BackgroundColor.

Parametry

-BackgroundColor

Określa kolor tła. Nie ma wartości domyślnej. Dopuszczalne wartości tego parametru to:

  • Czarny
  • Ciemny niebieski
  • Ciemna zieleń
  • Ciemny cyjan
  • Ciemny Czerwony
  • Ciemny Magenta
  • CiemnyŻółty
  • Szary
  • Ciemny szary
  • Niebieski
  • Zielony
  • Błękitny
  • Czerwony
  • Purpurowy róż
  • Żółty
  • Biała

Właściwości parametru

Typ:ConsoleColor
Domyślna wartość:None
Dopuszczalne wartości:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ForegroundColor

Określa kolor tekstu. Nie ma wartości domyślnej. Dopuszczalne wartości tego parametru to:

  • Czarny
  • Ciemny niebieski
  • Ciemna zieleń
  • Ciemny cyjan
  • Ciemny Czerwony
  • Ciemny Magenta
  • CiemnyŻółty
  • Szary
  • Ciemny szary
  • Niebieski
  • Zielony
  • Błękitny
  • Czerwony
  • Purpurowy róż
  • Żółty
  • Biała

Właściwości parametru

Typ:ConsoleColor
Domyślna wartość:None
Dopuszczalne wartości:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-NoNewline

Reprezentacje ciągów obiektów wejściowych są łączone w celu utworzenia danych wyjściowych. Między ciągami wyjściowymi nie są wstawione spacje ani nowe linie. Nie dodano nowego wiersza po ostatnim ciągu danych wyjściowych.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Object

Obiekty do wyświetlenia na hoście.

Właściwości parametru

Typ:Object
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:0
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Separator

Określa ciąg separatora, który ma być wstawiany między obiektami wyświetlanymi przez hosta.

Właściwości parametru

Typ:Object
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

Object

Można potokować obiekty, które mają być zapisywane na hoście.

Dane wyjściowe

None

Write-Host wysyła obiekty do hosta. Nie zwraca żadnych obiektów. Host może jednak wyświetlać obiekty, które Write-Host do niego wysyłane.