Share via

ProgressRecordType Enum

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Defines two types of progress record that refer to the beginning (or middle) and end of an operation.

public enum class ProgressRecordType
public enum ProgressRecordType
type ProgressRecordType = 
Public Enum ProgressRecordType
Inheritance
Enum
ProgressRecordType

Fields

Completed 1

Operation is complete.

If a cmdlet uses WriteProgress, it should use ProgressRecordType.Completed exactly once, in the last call to WriteProgress.

Processing 0

Operation just started or is not yet complete.

A cmdlet can call WriteProgress with ProgressRecordType.Processing as many times as it wishes. However, at the end of the operation, it should call once more with ProgressRecordType.Completed.

The first time that a host receives a progress record for a given activity, it will typically display a progress indicator for that activity. For each subsequent record of the same Id, the host will update that display. Finally, when the host receives a 'completed' record for that activity, it will remove the progress indicator.

Applies to