PSDataCollection Members

PSDataCollection Members

A thread safe buffer that is used by Windows PowerShell host applications to provide input data when invoking a pipeline of commands asynchronously. This class is introduced in Windows PowerShell 2.0.

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

(see also Protected Constructors)
 NameDescription
 PSDataCollectionOverloaded. Creates a new PSDataCollection object. The variants of this constructor can create an empty object, an object that contains input data, and an object that specifies the number of items that the input buffer can contain without resizing the buffer. This constructor is introduced by Windows PowerShell 2.0.
Top

  Name Description
  PSDataCollection Overloaded. Creates a new PSDataCollection object. The variants of this constructor can create an empty object, an object that contains input data, and an object that specifies the number of items that the input buffer can contain without resizing the buffer. This constructor is introduced by Windows PowerShell 2.0.
Top

  Name Description
public property BlockingEnumerator Gets or sets a value that indicates whether the data collection should have a blocking enumerator by default. Introduced in Windows PowerShell 3.0.
public property Count Gets the number of objects in the collection. This property is introduced in Windows PowerShell 2.0.
public property DataAddedCount Gets or sets the number of times that data can be added before the DataAdded event is fired. Introduced in Windows PowerShell 3.0.
public property EnumeratorNeverBlocks Gets or sets a value that indicates whether the returned enumerator can never block. Introduced in Windows PowerShell 3.0.
public property IsAutoGenerated Gets or sets a value that indicates whether this PSDataCollection was created implicitly in support of data collection. Introduced in Windows PowerShell 3.0.
public property IsOpen Gets a Boolean value that indicates whether the collection is available for adding objects. This property is introduced in Windows PowerShell 2.0.
public property IsReadOnly Gets a Boolean value that indicates whether objects can only be retrieved from the collection. This property is introduced in Windows PowerShell 2.0.
public property Item Gets and sets an object at the specified location of the collection. This property is introduced in Windows PowerShell 2.0.
public property SerializeInput Gets or sets a value that indicates whether to serialize all input by default. Introduced in Windows PowerShell 3.0.
Top

(see also Protected Methods)
 NameDescription
public methodAddAdds an object to the buffer. This method is introduced in Windows PowerShell 2.0.
public methodClearRemoves all objects from the buffer. This method is introduced in Windows PowerShell 2.0.
public methodCompleteCompletes the process of adding content to the collection. This method must be called before the collection can be used to invoke a pipeline asynchronously. This method is introduced in Windows PowerShell 2.0.
public methodContainsDetermines whether the specified object is in the buffer. This method is introduced in Windows PowerShell 2.0.
public methodCopyToCopies the contents of the buffer to an array, starting at the specified location. This method is introduced in Windows PowerShell 2.0.
public methodDisposeOverloaded. Releases the resources that are used by the PSDataCollection object. These methods implement the Dispose pattern used to release managed and unmanaged resources. This method is introduced in Windows PowerShell 2.0.
public methodEquals  (Inherited from Object)
public methodGetEnumeratorRetrieves an enumerator that can iterate through the objects in the buffer. This method is introduced in Windows PowerShell 2.0.
public methodGetHashCode  (Inherited from Object)
public methodGetObjectDataPopulates an object with the data needed to serialize the PSDataCollection. Introduced in Windows PowerShell 3.0.
public methodGetType  (Inherited from Object)
public methodIndexOfDetermines the index of the specified object in the buffer. This method is introduced in Windows PowerShell 2.0.
public methodInsertInserts an object at the specified location. This method is introduced in Windows PowerShell 2.0.
public methodstaticImplicitOverloaded. Wraps an argument in a PSDataCollection.
public methodReadAllMakes a shallow copy of items in the current collection and then clears the current collection. This method is introduced in Windows PowerShell 2.0.
public methodRemoveRemoves the first occurrence of the specified object from the buffer. This method is introduced in Windows PowerShell 2.0.
public methodRemoveAtRemoves the object at the specified location. This method is introduced in Windows PowerShell 2.0.
public methodToString  (Inherited from Object)
Top

(see also Extension Methods)
 NameDescription
protected methodDisposeOverloaded. Releases the resources that are used by the PSDataCollection object. These methods implement the Dispose pattern used to release managed and unmanaged resources. This method is introduced in Windows PowerShell 2.0.
protected methodFinalize  (Inherited from Object)
protected methodInsertItemInserts an object into the buffer at the specified location. This method is introduced in Windows PowerShell 2.0.
protected methodMemberwiseClone  (Inherited from Object)
protected methodRemoveItemRemoves the object at the specified location. This method is introduced in Windows PowerShell 2.0.
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 ByRef  Overloaded. (Defined by CollectionExtensions.)
public extension method ByRefEnumerable  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
public extension method Concat  Overloaded. (Defined by CollectionExtensions.)
public extension method ConcatSingleItem  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
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 Find  (Defined by Utilities.)
public extension method IsNullOrEmpty  Whether the collection object is null or an empty collection.This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
public extension method MyMax  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
public extension method SafeAggregate  This element is introduced in Windows PowerShell 5.0. (Defined by StringExtensions.)
public extension method ToCacheEnumerable  This element is introduced in Windows PowerShell 5.0. (Defined by CachingEnumerableExtensions.)
public extension method ToDictionaryNicely  This element is introduced in Windows PowerShell 5.0. (Defined by DictionaryExtensions.)
public extension method ToEnumerable  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
public extension method WhereNotNull  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
Top

  Name Description
public event Completed Event that is fired when the Complete method is called to indicate that no more data is to be added to the collection. This event is introduced in Windows PowerShell 2.0.
public event DataAdded Occurs after data is added to the collection. This event is introduced in Windows PowerShell 2.0.
public event DataAdding Occurs when objects are being added to the underlying buffer. Introduced in Windows PowerShell 3.0.
Top

  Name Description
  CopyTo Copies the elements of the collection to a specified array, starting at a specified index. This method is introduced in Windows PowerShell 2.0.
  GetEnumerator Retrieves the IEnumerator interface that can be used to access the objects of the collection. This method is introduced in Windows PowerShell 2.0.
  Add Appends an object to the collection. This method is introduced in Windows PowerShell 2.0.
  Contains Determines whether an object exists in the collection. This method is introduced in Windows PowerShell 2.0.
  IndexOf Retrieves the location of an object in the collection. This method is introduced in Windows PowerShell 2.0.
  Insert Places an object at a specific location in the collection. This method is introduced in Windows PowerShell 2.0.
  Remove Deletes the first occurrence of an object from the collection. This method is introduced in Windows PowerShell 2.0.
  IsSynchronized Gets a Boolean value that indicates whether the collection is synchronized. This property is introduced in Windows PowerShell 2.0.
  SyncRoot Gets the object used to synchronize access to the thread-safe collection. This property is introduced in Windows PowerShell 2.0.
  IsFixedSize Gets a Boolean value that indicates whether the size of the collection can be changed. This property is introduced in Windows PowerShell 2.0.
  IsReadOnly Gets a Boolean value that indicates whether objects cannot be added to the collection. This property is introduced in Windows PowerShell 2.0.
  Item Gets and sets the object at the specified location in the collection. This property is introduced in Windows PowerShell 2.0.
Top


Show:
© 2016 Microsoft