다음을 통해 공유

Write-Progress

  • 참조
모듈:
Microsoft.PowerShell.Utility

PowerShell 명령 창 내에 진행률 표시줄을 표시합니다.

구문

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

Description

Write-Progress cmdlet은 실행 중인 명령 또는 스크립트의 상태를 보여 주는 Windows PowerShell 명령 창에 진행률 표시줄을 표시합니다. 막대가 반영하는 표시기와 진행률 표시줄 위와 아래에 표시되는 텍스트를 선택할 수 있습니다.

예제

예제 1: For 루프의 진행률 표시

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

이 명령은 1에서 100까지 계산되는 For 루프의 진행률을 표시합니다.

Write-Progress cmdlet에는 작업의 상대적 완성도를 나타내는 상태 표시줄 제목 Activity, 상태 줄 및 변수 $i(For 루프의 카운터)가 포함됩니다.

예제 2: 중첩된 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

다음은 진행률 표시줄로 표시되는 두 개의 중첩된 For 루프의 진행률을 표시하는 예제입니다.

두 번째 진행률 표시줄에 대한 Write-Progress 명령에는 첫 번째 진행률 표시줄과 구분하는 Id 매개 변수가 포함됩니다.

Id 매개 변수가 없으면 진행률 표시줄이 다른 매개 변수 아래에 표시되는 대신 서로 중첩됩니다.

예제 3: 문자열을 검색하는 동안 진행률 표시

# 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을 곱하여 계산됩니다.

매개 변수

-Activity

상태 표시줄 위의 제목에 있는 텍스트의 첫 번째 줄을 지정합니다. 이 텍스트에서는 진행률이 보고되는 활동을 설명합니다.

형식:String
Position:1
Default value:None
필수:True
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-Completed

진행률 표시줄이 표시되는지 여부를 나타냅니다. 이 매개 변수를 생략하면 Write-Progress 진행률 정보를 표시합니다.

형식:SwitchParameter
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-CurrentOperation

진행률 표시줄 아래의 텍스트 줄을 지정합니다. 이 텍스트에서는 현재 수행 중인 작업에 대해 설명합니다.

형식:String
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-Id

각 진행률 표시줄을 다른 진행률 표시줄과 구분하는 ID를 지정합니다. 단일 명령에서 둘 이상의 진행률 표시줄을 만들 때 이 매개 변수를 사용합니다. 진행률 표시줄에 다른 ID가 없으면 계열에 표시되는 대신 겹쳐집니다.

형식:Int32
Position:3
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-ParentId

현재 활동의 부모 활동을 지정합니다. 현재 활동에 부모 활동이 없는 경우 -1 값을 사용합니다.

형식:Int32
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-PercentComplete

완료된 작업의 백분율을 지정합니다. 완료율을 알 수 없거나 적용할 수 없는 경우 -1 값을 사용합니다.

형식:Int32
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-SecondsRemaining

작업이 완료될 때까지 남은 예상 시간(초)을 지정합니다. 남은 시간(초)을 알 수 없거나 적용할 수 없는 경우 -1 값을 사용합니다.

형식:Int32
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-SourceId

레코드의 원본을 지정합니다.

형식:Int32
Position:Named
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

-Status

상태 표시줄 위의 제목에 있는 두 번째 텍스트 줄을 지정합니다. 이 텍스트는 활동의 현재 상태를 설명합니다.

형식:String
Position:2
Default value:None
필수:False
파이프라인 입력 허용:False
와일드카드 문자 허용:False

입력

None

이 cmdlet에 입력을 파이프할 수 없습니다.

출력

None

Write-Progress 출력을 생성하지 않습니다.

참고

진행률 표시줄이 표시되지 않으면 $ProgressPreference 변수의 값을 확인합니다. 값이 SilentlyContinue로 설정된 경우 진행률 표시줄이 표시되지 않습니다. Windows PowerShell 기본 설정에 대한 자세한 내용은 about_Preference_Variables참조하세요.

cmdlet의 매개 변수는 System.Management.Automation.ProgressRecord 클래스의 속성에 해당합니다. 자세한 내용은 MSDN 라이브러리의 ProgressRecord 클래스 참조하세요.