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.

PSWorkflowInstance Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

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

Namespace:   Microsoft.PowerShell.Workflow
Assembly:  Microsoft.PowerShell.Workflow.ServiceCore (in Microsoft.PowerShell.Workflow.ServiceCore.dll)

System::Object
  Microsoft.PowerShell.Workflow::PSWorkflowInstance

public ref class PSWorkflowInstance abstract : IDisposable

NameDescription
System_CAPS_protmethodPSWorkflowInstance()

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

NameDescription
System_CAPS_pubpropertyCreationContext

Gets the workflow job creation context.

Introduced in Windows PowerShell 4.0.

System_CAPS_protpropertyDisposed

Gets or sets a value that indicates whether the workflow instance has been disposed. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyError

Gets or sets the exception to throw when errors occur in the workflow. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyInstanceId

Gets the global identifier of the workflow instance. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyInstanceStore

Gets the instance store of the workflow. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyOnAborted

Gets the event handler for the OnAborted event. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyOnCompleted

Gets the event handler for the OnCompleted event. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyOnFaulted

Gets the event handler for the OnFaulted event. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyOnIdle

Gets the event handler for the OnIdle event. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyOnPersistableIdleAction

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.

System_CAPS_protpropertyOnStopped

Gets the event handler for the OnStopped event. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyOnSuspended

Gets the event handler for the OnSuspended event. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertyOnUnloaded

Gets the event handler for the OnUnloaded event. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSWorkflowContext

Gets or sets the workflow metadata. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSWorkflowDefinition

Gets the workflow definition. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyPSWorkflowJob

Gets the PowerShell workflow job associated with this workflow instance. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyRemoteActivityState

Gets or sets the remote activities state of the workflow.

Introduced in Windows PowerShell 4.0.

System_CAPS_pubpropertyState

Gets or sets the workflow job state. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyStreams

Gets or sets the output streams for the workflow. Introduced in Windows PowerShell 3.0.

System_CAPS_protpropertySyncLock

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.

System_CAPS_pubpropertyTimer

Gets or sets the timer for the workflow. Introduced in Windows PowerShell 3.0.

NameDescription
System_CAPS_pubmethodDispose()

Releases all resources used by this object. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by this object and optionally releases the managed resources. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodDisposeStreams()

Releases the streams used by the workflow instance. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoAbortInstance(String^)

Aborts the workflow instance. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoCreateInstance()

Loads the XAML to create an executable activity. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoExecuteInstance()

Runs this workflow instance. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoGetPersistableIdleAction(ReadOnlyCollection<BookmarkInfo^>^, Boolean)

Retrieves the action to take if the workflow becomes idle and persistence is allowed. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoPersistInstance()

Saves this workflow instance to a persisted memory store. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoRemoveInstance()

Removes this workflow instance from local memory and the persisted workflow store. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoResumeBookmark(Bookmark^, Object^)

Resumes a job that has been partially completed by a custom activity controller. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoResumeInstance(String^)

Resumes a previously suspended workflow. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoStopInstance()

Stops this workflow instance. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoSuspendInstance(Boolean)

Suspends the current workflow instance. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoTerminateInstance(String^)

Terminates this workflow. Introduced in Windows PowerShell 3.0.

System_CAPS_protmethodDoTerminateInstance(String^, Boolean)

Terminates this workflow.

Introduced in Windows PowerShell 4.0.

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()

(Inherited from Object.)

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: