Pipeline Class
TOC
Collapse the table of content
Expand the table of content

Pipeline Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Represents the base functionality of a pipeline that can be used to invoke commands.

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

System.Object
  System.Management.Automation.Runspaces.Pipeline

public abstract class Pipeline : IDisposable

NameDescription
System_CAPS_pubpropertyCommands

Gets the collection of commands for the pipeline.

System_CAPS_pubpropertyError

Gets the error output reader for the pipeline.

System_CAPS_pubpropertyHadErrors

Gets a value that indicates whether there were errors in the execution of the pipeline. Introduced in Windows PowerShell 3.0.

System_CAPS_pubpropertyInput

Gets the input writer for the pipeline.

System_CAPS_pubpropertyInstanceId

Gets the identifier for this instance of the pipeline.

System_CAPS_pubpropertyIsNested

Gets a Boolean value that indicates whether the pipeline is a nested pipeline.

System_CAPS_pubpropertyOutput

Gets the output reader for the pipeline.

System_CAPS_pubpropertyPipelineStateInfo

Gets information about the current state of the pipeline.

System_CAPS_pubpropertyRunspace

Gets the runspace of the pipeline.

System_CAPS_pubpropertySetPipelineSessionState

Gets and sets a Boolean value that indicates whether the session state will be updated for the current state of the pipeline.

NameDescription
System_CAPS_pubmethodConnect()

Connects synchronously to a running command on a remote server. The pipeline state must be Disconnected. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodConnectAsync()

Connects asynchronously to a running command on a remote server. The pipeline state must be Disconnected. Introduced in Windows PowerShell 3.0.

System_CAPS_pubmethodCopy()

Creates an exact copy of the current Pipeline object.

System_CAPS_pubmethodDispose()

Releases the resources used by the Pipeline object.

System_CAPS_protmethodDispose(Boolean)

Releases the resources used by the Pipeline object.

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

Invokes the pipeline synchronously.

System_CAPS_pubmethodInvoke(IEnumerable)

Invokes the pipeline synchronously.

System_CAPS_pubmethodInvokeAsync()

Invokes the pipeline asynchronously.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodStop()

Stops the execution of the pipeline synchronously.

System_CAPS_pubmethodStopAsync()

Stops the execution of the pipeline asynchronously.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventStateChanged

Occurs when the state of the pipeline changes.

Pipelines are created within the context of a runspace. Pipelines can be created using the following methods:

  • Runspace.CreatePipeline: Overloaded method that can be used to create a pipeline or to create a pipeline with a valid command string.

  • Runspace.CreateNestedPipeline: Overloaded method that can be used to create a nested pipeline or to create a nested pipeline with a valid command string.

You can derive from this class. However, there is no established scenario for doing this, nor has deriving from the class been tested.

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