Megosztás a következőn keresztül:

Write-Host

Modul:
Microsoft.PowerShell.Utility Module

Testre szabott kimenetet ír egy gazdagépre.

Syntax

Default (Alapértelmezett) 

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

Description

A Write-Host parancsmag elsődleges célja, hogy csak for-(host)-display-only kimenetet állítson elő, például színes szöveget nyomtasson, például amikor a felhasználót a Olvasási gazdagép. Write-Host a ToString() metódust használja a kimenet megírásához. Ezzel szemben a folyamathoz való adatkimenethez használja a Write-Output vagy implicit kimenetet.

A szöveg színét a ForegroundColor paraméterrel, a háttérszínt pedig a BackgroundColor paraméterrel adhatja meg. 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.

Megjegyzés:

A Windows PowerShell 5.0-tól kezdve a Write-Host egy burkoló elem a Write-Information. Ez lehetővé teszi, hogy a Write-Host segítségével kimenetet bocsásson ki az információs adatfolyamba. Ez lehetővé teszi, hogy a rögzítse vagy , miközben megőrzi a visszamenőleges kompatibilitást.

A $InformationPreference beállítási változó és InformationAction gyakori paraméter nem befolyásolja Write-Host üzeneteket. A szabály kivétele a -InformationAction Ignore, amely hatékonyan letiltja Write-Host kimenetét. (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 "no newline test" sztringet a NoNewline paraméterrel.

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. A 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 ForegroundColor paraméterrel sötétzöld szöveget, a BackgroundColor paramétert pedig fehér háttér megjelenítésére használja.

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, ahogy az ForegroundColor paraméter definiálja. A háttér fehér, a BackgroundColor paraméter által meghatározottak szerint.

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ő a InformationAction paramétert használja az Ignore értékével az adatfolyam kimenetének letiltásához. A második példa átirányítja a parancs információs adatfolyamát a $null változóra, és ezáltal letiltja azt. További információ: about_Output_Streams.

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

Paramétertulajdonságok

Típus:ConsoleColor
Alapértelmezett érték:None
Elfogadott értékek:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték: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

Paramétertulajdonságok

Típus:ConsoleColor
Alapértelmezett érték:None
Elfogadott értékek:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték: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 sorok. Az utolsó kimeneti sztring után nincs új vonal hozzáadva.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Object

A gazdagépen megjelenítendő objektumok.

Paramétertulajdonságok

Típus:Object
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False
Aliasok:Msg, Üzenet

Paraméterkészletek

(All)
Position:0
Kötelező:False
Folyamatból származó érték:True
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Separator

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

Paramétertulajdonságok

Típus:Object
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

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 a 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. A Write-Host @{a = 1; b = 2} például System.Collections.DictionaryEntry System.Collections.DictionaryEntry nyomtat a gazdagépre.