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.

PipelineReader<T> Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Provides asynchronous access to the stream of objects emitted by the Pipeline object.

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

System.Object
  System.Management.Automation.Runspaces.PipelineReader<T>

public abstract class PipelineReader<T>

Type Parameters

T

A type parameter representing the stream of objects emitted by the Pipeline object.

NameDescription
System_CAPS_protmethodPipelineReader<T>()

Initializes a new instance of the PipelineReader<T> class.

NameDescription
System_CAPS_pubpropertyCount

Gets the number of objects currently available in the stream.

System_CAPS_pubpropertyEndOfPipeline

Gets a value that indicates whether the stream is closed and contains no data.

System_CAPS_pubpropertyIsOpen

Gets a value that indicates whether the stream is open for further read operations.

System_CAPS_pubpropertyMaxCapacity

Gets the maximum capacity of the stream.

System_CAPS_pubpropertyWaitHandle

Gets the handle used to signal when data is available.

NameDescription
System_CAPS_pubmethodClose()

Closes the stream.

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

Reads all the objects currently in the stream without blocking processing.

System_CAPS_pubmethodNonBlockingRead(Int32)

Reads up to a maximum number of objects from the stream without blocking processing.

System_CAPS_pubmethodPeek()

Looks at the next object in the stream without its being removed. This method does not block processing.

System_CAPS_pubmethodRead()

Reads a single object from the stream.

System_CAPS_pubmethodRead(Int32)

Reads a maximum number of objects from the stream.

System_CAPS_pubmethodReadToEnd()

Reads all the objects to the end of the stream.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventDataReady

Occurs when data is added to the buffer.

This output reader object is exposed through calls to the Pipeline.Error and Pipeline.Output properties.

It is permitted to 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: