DataCollectionSink Class

  • Article

Diagnostic data adapters use a DataCollectionSink to store files and XML data for later attachment to bugs and test reports.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TestTools.Execution.DataCollectionSink

Namespace:  Microsoft.VisualStudio.TestTools.Execution
Assembly:  Microsoft.VisualStudio.QualityTools.ExecutionCommon (in Microsoft.VisualStudio.QualityTools.ExecutionCommon.dll)

Syntax

'Declaration
Public MustInherit Class DataCollectionSink

public abstract class DataCollectionSink

public ref class DataCollectionSink abstract

[<AbstractClass>]
type DataCollectionSink =  class end

public abstract class DataCollectionSink

The DataCollectionSink type exposes the following members.

Constructors

  Name Description
Protected method DataCollectionSink Initializes a new instance of the DataCollectionSink class.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SendFileAsync(FileTransferInformation) Sends an intermediate file asynchronously to the DataCollectionSink by using the provided file transfer information object.
Public method SendFileAsync(DataCollectionContext, String, Boolean) Sends a file asynchronously to the DataCollectionSink by using the parameters that are specified for this method.
Public method SendFileAsync(DataCollectionContext, String, String, Boolean) Sends an intermediate file asynchronously to the DataCollectionSink by using the parameters that are specified for this method.
Public method SendStreamAsync(StreamTransferInformation) Sends a stream to the DataCollectionSink by using the parameters that are specified for this method.
Public method SendStreamAsync(DataCollectionContext, Stream, String, Boolean) Sends a stream to the DataCollectionSink by using the parameters that are specified for this method.
Public method SendStreamAsync(DataCollectionContext, Stream, String, String, Boolean) Sends a stream to the DataCollectionSink by using the parameters that are specified for this method.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event SendFileCompleted Occurs when a file has been sent to the DataCollectionSink.
Public event SendStreamCompleted Occurs when a stream has been sent to the DataCollectionSink.

Top

Remarks

When your custom diagnostic data adapter is initialized, the testing framework provides a DataCollectionSink object for it to use.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.TestTools.Execution Namespace

DataCollector

Other Resources

Creating a Diagnostic Data Adapter to Collect Custom Data or Affect a Test Machine