Write-Progress

Write-Progress コマンドレットは、実行中のコマンドまたはスクリプトの状態を示す進行状況バーを Windows PowerShell コマンド ウィンドウに表示します。 バーが反映するインジケーターと、進行状況バーの上下に表示されるテキストを選択できます。

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

このコマンドは、1 から 100 までの数の For ループの進行状況を表示します。

Write-Progress コマンドレットには、タスクの相対的な完全性を示すステータス バーの見出し Activity、状態行、変数 $i (For ループ内のカウンター) が含まれています。

for($I = 1; $I -lt 101; $I++ )
{
    Write-Progress -Activity Updating -Status 'Progress->' -PercentComplete $I -CurrentOperation OuterLoop
    for($j = 1; $j -lt 101; $j++ )
    {
        Write-Progress -Id 1 -Activity Updating -Status 'Progress' -PercentComplete $j -CurrentOperation InnerLoop
    }
}

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

次の使用例は、入れ子になった 2 つの For ループの進行状況を表示します。それぞれのループは進行状況バーで表されます。

2 番目の進行状況バーの Write-Progress コマンドには、最初の進行状況バーと区別する Id パラメーターが含まれています。

ID パラメーターがないと、進行状況バーは互いに重ね合わされ、他方の下に表示されます。

# Use Get-EventLog to get the events in the System log and store them in the $Events variable.
$Events = Get-EventLog -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 a 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
    # 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 ($i/$Events.count*100)
} -End {
    # Display the matching messages using the out variable.
    $out
}

このコマンドは、システム イベント ログで文字列 "bios" を検索するコマンドの進行状況を表示します。

PercentComplete パラメーター値は、$I 処理されたイベントの数を、$Events.count 取得したイベントの合計数で割り、その結果を 100 で乗算することによって計算されます。

None

このコマンドレットに入力をパイプすることはできません。

None

Write-Progress は出力を生成しません。

進行状況バーが表示されない場合は、$ProgressPreference 変数の値を確認します。 値が SilentlyContinue に設定されている場合、進行状況バーは表示されません。 Windows PowerShell の基本設定の詳細については、「about_Preference_Variables」を参照してください。

コマンドレットのパラメーターは、System.Management.Automation.ProgressRecord クラスのプロパティに対応します。 詳細については、MSDN ライブラリ ProgressRecord クラス を参照してください。