Write-Host
Özelleştirilmiş çıkışı bir konağa yazar.
Syntax
Write-Host
[[-Object] <Object>]
[-NoNewline]
[-Separator <Object>]
[-ForegroundColor <ConsoleColor>]
[-BackgroundColor <ConsoleColor>]
[<CommonParameters>]
Description
Write-Host
Cmdlet'in birincil amacı, kullanıcıdan Read-Host ile birlikte giriş isterken olduğu gibi renkli metin yazdırma gibi for-(host)-display-only çıktısı üretmektir.
Write-Host
çıkışı yazmak için ToString() yöntemini kullanır. Buna karşılık, işlem hattına veri çıkışı yapmak için Write-Output veya örtük çıkış kullanın.
parametresini kullanarak metnin rengini ve parametresini ForegroundColor
kullanarak BackgroundColor
arka plan rengini belirtebilirsiniz. Ayırıcı parametresi, görüntülenen nesneleri ayırmak için kullanılacak bir dize belirtmenize olanak tanır. Belirli sonuç, PowerShell'i barındıran programa bağlıdır.
Not
Windows PowerShell 5.0'dan başlayarak Bu, Write-Host
bilgi akışına çıkış yaymak için Write-Information
kullanmanıza Write-Host
olanak tanıyan bir sarmalayıcıdır. Bu, geriye dönük uyumluluğu korurken kullanılarak Write-Host
yazılan verilerin yakalanmasına veya gizlenmesine olanak tanır.
Tercih $InformationPreference
değişkeni ve InformationAction
ortak parametre iletileri etkilemez Write-Host
. Bu kuralın özel durumu, çıkışı etkili bir şekilde gizleyen Write-Host
şeklindedir-InformationAction Ignore
. (bkz. "Örnek 5")
Örnekler
Örnek 1: Yeni satır eklemeden konsola yazma
Write-Host "no newline test " -NoNewline
Write-Host "second string"
no newline test second string
Bu komut parametresiyle 'yeni satır testi yok' dizesini NoNewline
görüntüler.
İkinci bir dize yazılır, ancak dizeleri ayıran yeni bir satır olmaması nedeniyle ilk dizeyle aynı satıra çıkar.
Örnek 2: Konsola yazma ve ayırıcı ekleme
Write-Host (2,4,6,8,10,12) -Separator ", +2= "
2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12
Bu komut, iki ile on iki arasında çift sayıları görüntüler. Ayırıcı parametresi dizeyi , +2=
(virgül, boşluk+
, , , 2
, =
boşluk) eklemek için kullanılır.
Örnek 3: Farklı metin ve arka plan renkleriyle yazma
Write-Host (2,4,6,8,10,12) -Separator ", -> " -ForegroundColor DarkGreen -BackgroundColor White
2, -> 4, -> 6, -> 8, -> 10, -> 12
Bu komut, iki ile on iki arasında çift sayıları görüntüler. Koyu yeşil metin çıkarmak için parametresini, BackgroundColor
beyaz arka planı görüntülemek için parametresini kullanırForegroundColor
.
Örnek 4: Farklı metin ve arka plan renkleriyle yazma
Write-Host "Red on white text." -ForegroundColor red -BackgroundColor white
Red on white text.
Bu komut "Beyaz metinde kırmızı" dizesini görüntüler. Metin, parametresi tarafından ForegroundColor
tanımlandığı gibi kırmızıdır. Arka plan, parametresi tarafından BackgroundColor
tanımlanan şekilde beyazdır.
Örnek 5: Write-Host çıkışını gizleme
# 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
Bu komutlar cmdlet'in çıkışını Write-Host
etkili bir şekilde bastırır. İlki, bilgi akışının InformationAction
çıkışını Ignore
engellemek için Value parametresini kullanır.
İkinci örnek, komutun bilgi akışını değişkenine $null
yönlendirir ve böylece bunu gizler.
Parametreler
-BackgroundColor
Arka plan rengini belirtir. Varsayılan değer yoktur. Bu parametrenin kabul edilebilir değerleri şunlardır:
- Siyahi
- Koyu Mavi
- Koyu Yeşil
- Koyu Mavi
- Koyu Kırmızı
- Koyu Eflatun
- Koyu Renkli
- Gri
- Koyu Gri
- Mavi
- Yeşil
- Camgöbeği
- Kırmızı
- Kırmızı
- Yellow
- Beyaz
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ForegroundColor
Metin rengini belirtir. Varsayılan değer yoktur. Bu parametrenin kabul edilebilir değerleri şunlardır:
- Siyahi
- Koyu Mavi
- Koyu Yeşil
- Koyu Mavi
- Koyu Kırmızı
- Koyu Eflatun
- Koyu Renkli
- Gri
- Koyu Gri
- Mavi
- Yeşil
- Camgöbeği
- Kırmızı
- Kırmızı
- Yellow
- Beyaz
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoNewline
Giriş nesnelerinin dize gösterimleri, çıkışı oluşturmak için birleştirilir. Çıkış dizeleri arasına boşluk veya yeni satır eklenmez. Son çıkış dizesinden sonra yeni satır eklenmez.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Object
Konakta görüntülenecek nesneler.
Type: | Object |
Aliases: | Msg, Message |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Separator
Konak tarafından görüntülenen nesneler arasına eklenecek ayırıcı dizeyi belirtir.
Type: | Object |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Girişler
Nesneleri konağa yazılacak şekilde yöneltebilirsiniz.
Çıkışlar
None
Write-Host
nesneleri konağa gönderir. Hiçbir nesne döndürmez. Ancak, konak ona gönderen nesneleri Write-Host
görüntüler.
Notlar
Konağa koleksiyon yazarken, koleksiyonun öğeleri tek bir boşlukla ayrılmış olarak aynı satıra yazdırılır. Bu, Ayırıcı parametresiyle geçersiz kılınabilir.
Özelliklere sahip nesneler gibi temel olmayan veri türleri beklenmeyen sonuçlara neden olabilir ve anlamlı bir çıkış sağlamaz. Örneğin,
Write-Host @{a = 1; b = 2}
konağa yazdırılırSystem.Collections.DictionaryEntry System.Collections.DictionaryEntry
.