Sdílet prostřednictvím

Write-Progress

Modul:
Microsoft.PowerShell.Utility Module

Zobrazí indikátor průběhu v příkazovém okně PowerShellu.

Syntax

Default (Výchozí) 

Write-Progress
    [-Activity] <String>
    [[-Status] <String>]
    [[-Id] <Int32>]
    [-PercentComplete <Int32>]
    [-SecondsRemaining <Int32>]
    [-CurrentOperation <String>]
    [-ParentId <Int32>]
    [-Completed]
    [-SourceId <Int32>]
    [<CommonParameters>]

Description

Rutina Write-Progress zobrazí indikátor průběhu v příkazovém okně PowerShellu, který znázorňuje stav spuštěného příkazu nebo skriptu. Můžete vybrat indikátory, které pruh odráží, a text, který se zobrazí nad a pod indikátorem průběhu.

PowerShell 7.2 přidal $PSStyle automatickou proměnnou, která slouží k řízení způsobu, jakým PowerShell zobrazuje určité informace pomocí řídicích sekvencí ANSI. Člen $PSStyle.Progress umožňuje řídit vykreslování panelu zobrazení průběhu.

  • $PSStyle.Progress.Style – řetězec ANSI, který nastavuje styl vykreslování.
  • $PSStyle.Progress.MaxWidth – nastaví maximální šířku zobrazení. Výchozí hodnota je 120. Minimální hodnota je 18.
  • $PSStyle.Progress.View - výčet s hodnotami, Minimal a Classic. Classic je stávající vykreslování beze změn. Minimal je jednařádkové minimální vykreslení. Minimal je výchozí.

Další informace o $PSStylenaleznete v tématu about_ANSI_Terminals.md.

Poznámka:

Pokud hostitel nepodporuje virtuální terminál, $PSStyle.Progress.View se automaticky nastaví na Classic.

Příklady

Příklad 1: Zobrazení průběhu smyčky For

for ($i = 1; $i -le 100; $i++ ) {
    Write-Progress -Activity "Search in Progress" -Status "$i% Complete:" -PercentComplete $i
    Start-Sleep -Milliseconds 250
}

Tento příkaz zobrazí průběh smyčky for, která počítá od 1 do 100.

Rutina Write-Progress obsahuje záhlaví stavového řádku Activity, stavový řádek a proměnnou $i (čítač ve smyčce for), která označuje relativní úplnost úlohy.

Příklad 2: Zobrazení průběhu vnořených smyček For

$PSStyle.Progress.View = 'Classic'

for($I = 0; $I -lt 10; $I++ ) {
    $OuterLoopProgressParameters = @{
        Activity         = 'Updating'
        Status           = 'Progress->'
        PercentComplete  = $I * 10
        CurrentOperation = 'OuterLoop'
    }
    Write-Progress @OuterLoopProgressParameters
    for($j = 1; $j -lt 101; $j++ ) {
        $InnerLoopProgressParameters = @{
            ID               = 1
            Activity         = 'Updating'
            Status           = 'Progress'
            PercentComplete  = $j
            CurrentOperation = 'InnerLoop'
        }
        Write-Progress @InnerLoopProgressParameters
        Start-Sleep -Milliseconds 25
    }
}

Updating
Progress ->
 [ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo]
OuterLoop
Updating
Progress
 [oooooooooooooooooo                                                   ]
InnerLoop

Tento příklad nastaví zobrazení průběhu na Classic a pak zobrazí průběh dvou vnořených for smyček, z nichž každý představuje indikátor průběhu.

Příkaz Write-Progress druhého indikátoru průběhu obsahuje parametr id , který ho odlišuje od prvního indikátoru průběhu.

Bez ID parametru by byly indikátory průběhu překryvné na sebe místo toho, aby se zobrazovaly pod druhým.

Příklad 3: Zobrazení průběhu hledání řetězce

# Use Get-WinEvent to get the events in the System log and store them in the $Events variable.
$Events = Get-WinEvent -LogName system
# Pipe the events to the ForEach-Object cmdlet.
$Events | ForEach-Object -Begin {
    # In the Begin block, use Clear-Host to clear the screen.
    Clear-Host
    # Set the $i counter variable to zero.
    $i = 0
    # Set the $out variable to an empty string.
    $out = ""
} -Process {
    # In the Process script block search the message property of each incoming object for "bios".
    if($_.message -like "*bios*")
    {
        # Append the matching message to the out variable.
        $out=$out + $_.Message
    }
    # Increment the $i counter variable which is used to create the progress bar.
    $i = $i+1
    # Determine the completion percentage
    $Completed = ($i/$Events.count) * 100
    # Use Write-Progress to output a progress bar.
    # The Activity and Status parameters create the first and second lines of the progress bar
    # heading, respectively.
    Write-Progress -Activity "Searching Events" -Status "Progress:" -PercentComplete $Completed
} -End {
    # Display the matching messages using the out variable.
    $out
}

Tento příkaz zobrazí průběh příkazu k vyhledání řetězce bios v protokolu událostí systému.

Hodnota parametru PercentComplete se vypočítá vydělením počtu zpracovaných událostí celkovým počtem načtených událostí a následným vynásobením výsledku číslem 100.

Příklad 4: Zobrazení průběhu pro každou úroveň vnořeného procesu

$PSStyle.Progress.View = 'Classic'

foreach ( $i in 1..10 ) {
  Write-Progress -Id 0 "Step $i"
  foreach ( $j in 1..10 ) {
    Write-Progress -Id 1 -ParentId 0 "Step $i - Substep $j"
    foreach ( $k in 1..10 ) {
      Write-Progress -Id 2  -ParentId 1 "Step $i - Substep $j - iteration $k"
      Start-Sleep -Milliseconds 150
    }
  }
}

Step 1
     Processing
    Step 1 - Substep 2
         Processing
        Step 1 - Substep 2 - Iteration 3
             Processing

V tomto příkladu můžete pomocí parametru ParentId odsazení výstupu zobrazit vztahy nadřazenosti a podřízenosti v průběhu jednotlivých kroků.

Parametry

-Activity

Určuje první řádek textu v záhlaví nad stavovým řádkem. Tento text popisuje aktivitu, jejíž průběh se hlásí.

Vlastnosti parametru

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

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

-Completed

Určuje, jestli je indikátor průběhu viditelný. Pokud tento parametr vynecháte, Write-Progress zobrazí informace o průběhu.

Vlastnosti parametru

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

Sady parametrů

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

-CurrentOperation

Určuje řádek textu pod indikátorem průběhu. Tento text popisuje operaci, která se právě provádí.

Vlastnosti parametru

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

Sady parametrů

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

-Id

Určuje ID, které rozlišuje jednotlivé indikátory průběhu od ostatních. Tento parametr použijte při vytváření více než jednoho indikátoru průběhu v jednom příkazu. Pokud indikátory průběhu nemají jiná ID, jsou místo zobrazení v řadě překryvné. Záporné hodnoty nejsou povolené.

Vlastnosti parametru

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

Sady parametrů

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

-ParentId

Určuje nadřazenou aktivitu aktuální aktivity. Pokud aktuální aktivita nemá žádnou nadřazenou aktivitu, použijte hodnotu -1.

Vlastnosti parametru

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

Sady parametrů

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

-PercentComplete

Určuje procento dokončené aktivity. Použijte hodnotu -1, pokud je procento dokončení neznámé nebo nelze použít.

Vlastnosti parametru

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

Sady parametrů

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

-SecondsRemaining

Určuje předpokládaný počet sekund zbývající do dokončení aktivity. Hodnotu použijte -1, pokud je počet sekund, které zbývá, neznámé nebo nepoužitelné.

Vlastnosti parametru

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

Sady parametrů

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

-SourceId

Určuje zdroj záznamu. Můžete ho použít místo id , ale nemůžete ho použít s jinými parametry, jako je ParentId.

Vlastnosti parametru

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

Sady parametrů

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

-Status

Určuje druhý řádek textu v záhlaví nad stavovým řádkem. Tento text popisuje aktuální stav aktivity.

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

Do tohoto cmdletu nemůžete předávat objekty.

Výstupy

None

Tento cmdlet nevrátí žádný výstup.

Poznámky

Pokud se indikátor průběhu nezobrazí, zkontrolujte hodnotu proměnné $ProgressPreference. Pokud je hodnota nastavená na SilentlyContinue, indikátor průběhu se nezobrazí. Další informace o předvolbách PowerShellu najdete v tématu about_Preference_Variables.

Parametry rutiny odpovídají vlastnostem System.Management.Automation.ProgressRecord třídy. Další informace naleznete v tématu ProgressRecord Třída.