RemotingProgressRecord Class

  • Reference

Definition

Namespace:
System.Management.Automation.Runspaces
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

Progress record containing origin information.

public ref class RemotingProgressRecord : System::Management::Automation::ProgressRecord
public class RemotingProgressRecord : System.Management.Automation.ProgressRecord
[System.Runtime.Serialization.DataContract]
public class RemotingProgressRecord : System.Management.Automation.ProgressRecord
type RemotingProgressRecord = class
    inherit ProgressRecord
[<System.Runtime.Serialization.DataContract>]
type RemotingProgressRecord = class
    inherit ProgressRecord
Public Class RemotingProgressRecord
Inherits ProgressRecord
Inheritance
Object
ProgressRecord
RemotingProgressRecord
Attributes
DataContractAttribute

Constructors

RemotingProgressRecord(ProgressRecord, OriginInfo)

Constructor.

Properties

Activity

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

(Inherited from ProgressRecord)
ActivityId

Gets the Id of the activity to which this record corresponds. Used as a 'key' for the linking of subordinate activities.

(Inherited from ProgressRecord)
CurrentOperation

Gets and sets the current operation of the many required to accomplish the activity (such as "copying foo.txt"). Normally displayed below its associated progress bar, e.g., "deleting file foo.bar" Set to null or empty in the case a sub-activity will be used to show the current operation.

(Inherited from ProgressRecord)
OriginInfo

Contains the origin information.
ParentActivityId

Gets and sets the Id of the activity for which this record is a subordinate.

(Inherited from ProgressRecord)
PercentComplete

Gets and sets the estimate of the percentage of total work for the activity that is completed. Typically displayed as a progress bar. Set to a negative value to indicate that the percentage completed should not be displayed.

(Inherited from ProgressRecord)
RecordType

Gets and sets the type of record represented by this instance.

(Inherited from ProgressRecord)
SecondsRemaining

Gets and sets the estimate of time remaining until this activity is completed. This can be based upon a measurement of time since started and the percent complete or another approach deemed appropriate by the caller.

Normally displayed beside the progress bar, as "N seconds remaining."

(Inherited from ProgressRecord)
StatusDescription

Gets and sets the current status of the operation, e.g., "35 of 50 items Copied." or "95% completed." or "100 files purged."

(Inherited from ProgressRecord)

Methods

ToString()

Overrides ToString()

(Inherited from ProgressRecord)

Applies to