Write-Host
Özelleştirilmiş çıkışı bir konağa yazar.
Sözdizimi
Default EnterprisePublishing
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 yalnızca görüntüleme için (ana bilgisayar) çıkış ü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.
ForegroundColor parametresini kullanarak metnin rengini ve BackgroundColor parametresini kullanarak 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 bir sonuç, PowerShell'i barındıran programa bağlıdır.
Uyarı
Windows PowerShell 5.0'dan başlayarak, Write-HostWrite-Information için bir sarmalayıcıdır. Bu, bilgi akışına çıktı yaymak için Write-Host kullanmanıza olanak tanır. Bu, geriye dönük uyumluluğu korurken
$InformationPreference tercih değişkeni ve InformationAction ortak parametresi Write-Host iletileri etkilemez. Bu kuralın özel durumu, -InformationAction Ignore çıkışı etkili bir şekilde gizleyen Write-Host' dir. (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, NoNewline parametresiyle 'yeni satır testi yok' dizesini görüntüler.
İkinci bir dize yazılır, ancak dizeleri ayıran yeni bir satır olmaması nedeniyle ilk dizeyle aynı satırda biter.
Ö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 ForegroundColor ve BackgroundColor beyaz arka planı görüntülemek için parametresini kullanır.
Ö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 tanımlandığı gibi kırmızıdır ForegroundColor . Arka plan, parametresi tarafından BackgroundColor tanımlanan şekilde beyazdır.
Örnek 5: Write-Host çıktıyı 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. Daha fazla bilgi için bkz . about_Output_Streams.
Parametreler
-BackgroundColor
Arka plan rengini belirtir. Varsayılan değer yoktur. Bu parametre için kabul edilebilir değerler şunlardır:
BlackDarkBlueDarkGreenDarkCyanDarkRedDarkMagentaDarkYellowGrayDarkGrayBlueGreenCyanRedMagentaYellowWhite
Parametre özellikleri
| Tür: | ConsoleColor |
| Default value: | None |
| Kabul edilen değerler: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-ForegroundColor
Metin rengini belirtir. Varsayılan değer yoktur. Bu parametre için kabul edilebilir değerler şunlardır:
BlackDarkBlueDarkGreenDarkCyanDarkRedDarkMagentaDarkYellowGrayDarkGrayBlueGreenCyanRedMagentaYellowWhite
Parametre özellikleri
| Tür: | ConsoleColor |
| Default value: | None |
| Kabul edilen değerler: | Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | 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.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Object
Konakta görüntülenecek nesneler.
Parametre özellikleri
| Tür: | Object |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | Msg, Mesaj |
Parametre kümeleri
(All)
| Position: | 0 |
| Zorunlu: | False |
| İşlem hattından gelen değer: | True |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Separator
Konak tarafından görüntülenen nesneler arasına eklenecek ayırıcı dizeyi belirtir.
Parametre özellikleri
| Tür: | Object |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
CommonParameters
Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.
Girişler
Object
Konağa yazılacak nesneleri bu cmdlet'e yöneltebilirsiniz.
Çıkışlar
None
Bu cmdlet çıkış döndürmez. Nesneleri konağa gönderir. Konak, bu cmdlet'in ona gönderdiği nesneleri 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.
Özellikleri olan nesneler gibi ilkel 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.