PSWorkflowInstance Members

Represents all of the information related to a workflow instance. Introduced in Windows PowerShell 3.0.

The following tables list the members exposed by the PSWorkflowInstance type.

  Name Description
  PSWorkflowInstance Initializes a new instance of the PSWorkflowInstance class. Introduced in Windows PowerShell 3.0.
Top

(see also Protected Properties)
 NameDescription
public propertyCreationContextTBD. Introduced in Windows PowerShell 4.0.
public propertyErrorGets or sets the exception to throw when errors occur in the workflow. Introduced in Windows PowerShell 3.0.
public propertyInstanceIdGets the global identifier of the workflow instance. Introduced in Windows PowerShell 3.0.
public propertyInstanceStoreGets the instance store of the workflow. Introduced in Windows PowerShell 3.0.
public propertyPSWorkflowContextGets or sets the workflow metadata. Introduced in Windows PowerShell 3.0.
public propertyPSWorkflowDefinitionGets the workflow definition. Introduced in Windows PowerShell 3.0.
public propertyPSWorkflowJobGets the PowerShell workflow job associated with this workflow instance. Introduced in Windows PowerShell 3.0.
public propertyRemoteActivityStateTBD. Introduced in Windows PowerShell 4.0.
public propertyStateGets or sets the workflow job state. Introduced in Windows PowerShell 3.0.
public propertyStreamsGets or sets the output streams for the workflow. Introduced in Windows PowerShell 3.0.
public propertyTimerGets or sets the timer for the workflow. Introduced in Windows PowerShell 3.0.
Top

  Name Description
protected property Disposed Gets or sets a value that indicates whether the workflow instance has been disposed. Introduced in Windows PowerShell 3.0.
protected property OnAborted Gets the event handler for the OnAborted event. Introduced in Windows PowerShell 3.0.
protected property OnCompleted Gets the event handler for the OnCompleted event. Introduced in Windows PowerShell 3.0.
protected property OnFaulted Gets the event handler for the OnFaulted event. Introduced in Windows PowerShell 3.0.
protected property OnIdle Gets the event handler for the OnIdle event. Introduced in Windows PowerShell 3.0.
protected property OnPersistableIdleAction Gets the event handler for the OnPersistableIdleAction event, which determines what action to take if the workflow becomes idle and persistence is allowed. Introduced in Windows PowerShell 3.0.
protected property OnStopped Gets the event handler for the OnStopped event. Introduced in Windows PowerShell 3.0.
protected property OnSuspended Gets the event handler for the OnSuspended event. Introduced in Windows PowerShell 3.0.
protected property OnUnloaded Gets the event handler for the OnUnloaded event. Introduced in Windows PowerShell 3.0.
protected property SyncLock Gets a synchronization object available to derived classes. This object is available to applications or services to coordinate the execution of multiple threads. Introduced in Windows PowerShell 3.0.
Top

(see also Protected Methods)
 NameDescription
public methodDisposeOverloaded.  
public methodDisposeStreamsReleases the streams used by the workflow instance. Introduced in Windows PowerShell 3.0.
public methodEquals  (Inherited from Object)
public methodGetHashCode  (Inherited from Object)
public methodGetType  (Inherited from Object)
public methodToString  (Inherited from Object)
Top

(see also Extension Methods)
 NameDescription
protected methodDisposeOverloaded.  
protected methodDoAbortInstanceAborts the workflow instance. Introduced in Windows PowerShell 3.0.
protected methodDoCreateInstanceLoads the XAML to create an executable activity. Introduced in Windows PowerShell 3.0.
protected methodDoExecuteInstanceRuns this workflow instance. Introduced in Windows PowerShell 3.0.
protected methodDoGetPersistableIdleActionRetrieves the action to take if the workflow becomes idle and persistence is allowed. Introduced in Windows PowerShell 3.0.
protected methodDoPersistInstanceSaves this workflow instance to a persisted memory store. Introduced in Windows PowerShell 3.0.
protected methodDoRemoveInstanceRemoves this workflow instance from local memory and the persisted workflow store. Introduced in Windows PowerShell 3.0.
protected methodDoResumeBookmarkResumes a job that has been partially completed by a custom activity controller. Introduced in Windows PowerShell 3.0.
protected methodDoResumeInstanceResumes a previously suspended workflow. Introduced in Windows PowerShell 3.0.
protected methodDoStopInstanceStops this workflow instance. Introduced in Windows PowerShell 3.0.
protected methodDoSuspendInstanceSuspends the current workflow instance. Introduced in Windows PowerShell 3.0.
protected methodDoTerminateInstanceOverloaded. Terminates this workflow.
protected methodFinalize  (Inherited from Object)
protected methodMemberwiseClone  (Inherited from Object)
Top

  Name Description
public extension method As  Use this method to adapt an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method As  This is called to adapt an object from a foreign app domain to a known interface in this appDomainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method As  Adapts an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  Use this method to adapt and extend an object so that you can pass it to a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  This is called to adapt and extend an object that we wish to pass to a foreign app domainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  Used to extend an object with an interface from a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method ToEnumerable  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
Top


Show: