Windows desktop applications
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ProgressRecord Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Represent the status of an ongoing operation at a point in time.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)


[DataContractAttribute]
public class ProgressRecord

NameDescription
System_CAPS_pubmethodProgressRecord(Int32, String, String)

Initializes a new instance of the ProgressRecord class that contains the current activity identifier, a description of the current activity, and a description of the status.

NameDescription
System_CAPS_pubpropertyActivity

Gets or sets the description of the activity for which progress is being reported.

System_CAPS_pubpropertyActivityId

Gets the identifier of the activity to which this record corresponds.

System_CAPS_pubpropertyCurrentOperation

Gets or sets the current operation of the activity.

System_CAPS_pubpropertyParentActivityId

Gets or sets the identifier of the activity for which this record is a subordinate.

System_CAPS_pubpropertyPercentComplete

Gets or sets an estimate of the percentage of total work that is completed for the activity.

System_CAPS_pubpropertyRecordType

Gets or sets the overall status (Processing or Completed) of the activity.

System_CAPS_pubpropertySecondsRemaining

Gets or sets an estimate of time that remains until this activity is completed.

System_CAPS_pubpropertyStatusDescription

Gets or sets a description of the current status of the activity.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

Generates a string representation of the progress record.(Overrides Object.ToString().)

Progress records are forwarded to the host for rendering by calls to the WriteProgress method. Progress record information is displayed according to user preference.

The ProgressRecord class is used only by the Windows PowerShell runtime. There are no established scenarios for deriving from this class.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft