Sdílet prostřednictvím


Write-Information

Určuje, jak prostředí Windows PowerShell zpracovává data informačního streamu pro příkaz.

Syntax

Default (Výchozí)

Write-Information
    [-MessageData] <Object>
    [[-Tags] <String[]>]
    [<CommonParameters>]

Description

Rutina Write-Information určuje, jak prostředí Windows PowerShell zpracovává data toku informací pro příkaz.

Windows PowerShell 5.0 zavádí nový strukturovaný informační proud (číslo 6 v datových proudech Windows PowerShell), který můžete použít k přenosu strukturovaných dat mezi skriptem a jeho volajícími (nebo hostitelským prostředím). Write-Information umožňuje přidat do datového proudu informační zprávu a určit, jak prostředí Windows PowerShell zpracovává data informačního streamu pro příkaz. Informační proudy fungují také pro PowerShell.Streamsúlohy, naplánované úlohy a pracovní postupy.

Poznámka:

Informační stream nedodržuje standardní konvenci předpony zpráv s názvem [Název streamu]:" To bylo určeno pro stručnost a vizuální čistotu.

Hodnota proměnné předvoleb $InformationPreference určuje, jestli se zpráva, kterou zadáte Write-Information, zobrazí v očekávaném bodě operace skriptu. Protože výchozí hodnota této proměnné je , ve výchozím nastavení se SilentlyContinueinformační zprávy nezobrazují. Pokud nechcete změnit hodnotu , $InformationPreferencemůžete její hodnotu přepsat přidáním společného parametru do vašeho příkazu InformationAction . Další informace naleznete v části about_Preference_Variables a about_CommonParameters.

Poznámka:

Počínaje Windows PowerShellem 5.0 je Write-Host obálka pro Write-Information. To umožňuje použít Write-Host k vygenerování výstupu do informačního datového proudu. To umožňuje zachycení nebo potlačení dat zapsaných pomocí Write-Host a zachování zpětné kompatibility. Další informace naleznete v tématu Write-Host

Write-Information je také podporovanou aktivitou pracovního postupu.

Příklady

Příklad 1: Zápis informací pro výsledky příkazu Get-

Get-WindowsFeature -Name p*; Write-Information -MessageData "Got your features!" -InformationAction Continue
Display Name                                            Name                       Install State
------------                                            ----                       -------------
[ ] Print and Document Services                         Print-Services                 Available
    [ ] Print Server                                    Print-Server                   Available
    [ ] Distributed Scan Server                         Print-Scan-Server              Available
    [ ] Internet Printing                               Print-Internet                 Available
    [ ] LPD Service                                     Print-LPD-Service              Available
[ ] Peer Name Resolution Protocol                       PNRP                           Available
[X] Windows PowerShell                                  PowerShellRoot                 Installed
    [X] Windows PowerShell 5.0                          PowerShell                     Installed
    [ ] Windows PowerShell 2.0 Engine                   PowerShell-V2                    Removed
    [X] Windows PowerShell ISE                          PowerShell-ISE                 Installed
Got your features!

V tomto příkladu se po spuštění příkazu zobrazí informační zpráva "Got your features!" pro vyhledání Get-WindowsFeature všech funkcí, které mají hodnotu Name začínající na "p". Protože je proměnná stále nastavena $InformationPreference na výchozí hodnotu, SilentlyContinuemůžete přidáním parametru InformationAction přepsat $InformationPreference hodnotu a zobrazit zprávu. Hodnota InformationAction je Pokračovat, což znamená, že se zpráva zobrazí, ale skript nebo příkaz pokračuje, pokud ještě není dokončen.

Příklad 2: Zápis informací a označení

Get-WindowsFeature -Name p*; Write-Information -MessageData "To filter your results for PowerShell, pipe your results to the Where-Object cmdlet." -Tags "Instructions" -InformationAction Continue
Display Name                                            Name                       Install State
------------                                            ----                       -------------
[ ] Print and Document Services                         Print-Services                 Available
    [ ] Print Server                                    Print-Server                   Available
    [ ] Distributed Scan Server                         Print-Scan-Server              Available
    [ ] Internet Printing                               Print-Internet                 Available
    [ ] LPD Service                                     Print-LPD-Service              Available
[ ] Peer Name Resolution Protocol                       PNRP                           Available
[X] Windows PowerShell                                  PowerShellRoot                 Installed
    [X] Windows PowerShell 5.0                          PowerShell                     Installed
    [ ] Windows PowerShell 2.0 Engine                   PowerShell-V2                    Removed
    [X] Windows PowerShell ISE                          PowerShell-ISE                 Installed
To filter your results for PowerShell, pipe your results to the Where-Object cmdlet.

V tomto příkladu použijete Write-Information, abyste uživatelům dali vědět, že po spuštění aktuálního příkazu budou muset spustit další příkaz. V příkladu je do informační zprávy přidán tag Instructions. Pokud po spuštění tohoto příkazu vyhledáte v informačním streamu zprávy s tagem Instrukce, bude mezi výsledky i zde zadaná zpráva.

Příklad 3: Zápis informací do souboru

function Test-Info
{
    Get-Process P*
    Write-Information "Here you go"
}
Test-Info 6> Info.txt

V tomto příkladu přesměrujete datový proud informací ve funkci do souboru, Info.txt, pomocí kódu 6>. Když otevřete soubor Info.txt, zobrazí se text "Tady to máte".

Parametry

-MessageData

Určuje informační zprávu, kterou chcete uživatelům zobrazit při spuštění skriptu nebo příkazu. Nejlepších výsledků dosáhnete uzavřením informační zprávy do uvozovek. Příkladem je "Test dokončen".

Vlastnosti parametru

Typ:Object
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Msg

Sady parametrů

(All)
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Tags

Určuje jednoduchý řetězec, který můžete použít k řazení a filtrování zpráv, které jste přidali do informačního streamu pomocí Write-Information. Tento parametr funguje podobně jako parametr Tags v New-ModuleManifest.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:1
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Write-Information Nepřijímá zřetězený vstup.

Výstupy

InformationRecord