Write-Host

  • Referencia
Modul:
Microsoft.PowerShell.Utility

Testre szabott kimenetet ír egy gazdagépre.

Syntax

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

Description

A Write-Host parancsmag elsődleges célja a csak for-(host)-display-only kimenet előállítása, például színes szöveg nyomtatása, például amikor a felhasználót a Read-Hosttal együtt kéri a bemenetre. Write-Host A kimenet írásához a ToString() metódust használja. Ezzel szemben a folyamat adatainak kimenetéhez használja a Write-Output vagy implicit kimenetet.

A paraméterrel ForegroundColor megadhatja a szöveg színét, a háttérszínt pedig a BackgroundColor paraméterrel. Az Elválasztó paraméterrel megadhat egy sztringet, amellyel elkülönítheti a megjelenített objektumokat. Az adott eredmény a PowerShellt üzemeltető programtól függ.

Feljegyzés

A Windows PowerShell 5.0-tól Write-Host kezdődően ez egy burkoló Write-Information , amellyel Write-Host kimenetet bocsáthat ki az adatfolyamba. Ez lehetővé teszi a visszafelé kompatibilitás megőrzése mellett írt Write-Host adatok rögzítését vagy letiltását.

A $InformationPreference beállítási változó és InformationAction a gyakori paraméter nem befolyásolja az Write-Host üzeneteket. Kivétel ez alól a szabály, -InformationAction Ignoreamely hatékonyan letiltja a kimenetet Write-Host . (lásd: "5. példa")

Példák

1. példa: Írás a konzolra új sor hozzáadása nélkül

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

no newline test second string

Ez a parancs megjeleníti a paraméterrel együtt a NoNewline "no newline test" sztringet.

A második sztring meg van írva, de a sztringeket elválasztó új vonal hiánya miatt az elsővel azonos sorba kerül.

2. példa: Írás a konzolra, és elválasztójel

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

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

Ez a parancs két és tizenkét közötti páros számokat jelenít meg. Az Elválasztó paraméter a sztring , +2= (vessző, szóköz, +, 2=szóköz) hozzáadására szolgál.

3. példa: Írás különböző szöveggel és háttérszínekkel

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

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

Ez a parancs két és tizenkét közötti páros számokat jelenít meg. A paraméterrel ForegroundColor sötétzöld szöveget ad ki, a BackgroundColor paraméter pedig fehér hátteret jelenít meg.

4. példa: Írás különböző szöveggel és háttérszínekkel

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

Red on white text.

Ez a parancs a "Piros a fehér szövegen" sztringet jeleníti meg. A szöveg piros, a paraméter által ForegroundColor meghatározott módon. A háttér fehér, a paraméter által BackgroundColor meghatározott módon.

5. példa: A Write-Host kimenetének letiltása

# 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

Ezek a parancsok hatékonyan letiltják a Write-Host parancsmag kimenetét. Az első az InformationAction Érték paraméterrel Ignore letiltja az adatfolyam kimenetét. A második példa átirányítja a parancs információs adatfolyamát a $null változóhoz, és ezáltal letiltja azt. További információ: about_Output_adatfolyamok.

Paraméterek

-BackgroundColor

A háttérszínt adja meg. Nincs alapértelmezett beállítás. A paraméter elfogadható értékei a következők:

  • Black
  • DarkBlue
  • DarkGreen
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Gray
  • DarkGray
  • Blue
  • Green
  • Cyan
  • Red
  • Magenta
  • Yellow
  • White
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

A szöveg színét adja meg. Nincs alapértelmezett beállítás. A paraméter elfogadható értékei a következők:

  • Black
  • DarkBlue
  • DarkGreen
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Gray
  • DarkGray
  • Blue
  • Green
  • Cyan
  • Red
  • Magenta
  • Yellow
  • White
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

A bemeneti objektumok sztringreprezentációi összefűzve jelennek meg a kimenet létrehozásához. A kimeneti sztringek között nincsenek szóközök vagy új vonalak. Az utolsó kimeneti sztring után nincs új vonal hozzáadva.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Object

A gazdagépen megjelenítendő objektumok.

Type:Object
Aliases:Msg, Message
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Separator

A gazdagép által megjelenített objektumok közé beszúrandó elválasztó sztringet adja meg.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Bevitelek

Object

A parancsmagba a gazdagépnek írandó objektumokat csövezheti.

Kimenetek

None

Ez a parancsmag nem ad vissza kimenetet. Elküldi az objektumokat a gazdagépnek. A gazdagép megjeleníti a parancsmag által neki küldött objektumokat.

Jegyzetek

  • Ha gyűjteményt ír a gazdagépnek, a gyűjtemény elemei ugyanazon a sorban jelennek meg, egyetlen szóközzel elválasztva. Ezt felül lehet bírálni az Elválasztó paraméterrel.

  • A nem primitív adattípusok, például a tulajdonságokkal rendelkező objektumok váratlan eredményeket okozhatnak, és nem nyújtanak értelmes kimenetet. Például Write-Host @{a = 1; b = 2} a gazdagépre fog nyomtatni System.Collections.DictionaryEntry System.Collections.DictionaryEntry .