MainPipe Interface

Provides the managed implementation of the IDTSPipeline100 interface used to programmatically configure a data flow task.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntax

'Declaration
<GuidAttribute("89CEBA86-EC51-4C62-A2D3-E9AA4FC28900")> _
Public Interface MainPipe _
    Inherits IDTSPipeline100
'Usage
Dim instance As MainPipe

[GuidAttribute("89CEBA86-EC51-4C62-A2D3-E9AA4FC28900")]
public interface MainPipe : IDTSPipeline100

[GuidAttribute(L"89CEBA86-EC51-4C62-A2D3-E9AA4FC28900")]
public interface class MainPipe : IDTSPipeline100

[<GuidAttribute("89CEBA86-EC51-4C62-A2D3-E9AA4FC28900")>]
type MainPipe =  
    interface
        interface IDTSPipeline100
    end

public interface MainPipe extends IDTSPipeline100

The MainPipe type exposes the following members.

Properties

	Name	Description
	AutoGenerateIDForNewObjects	Gets or sets a value that specifies whether the data flow automatically generates and sets the ID property for newly created objects. (Inherited from IDTSPipeline100.)
	BLOBTempStoragePath	Gets or sets a value that specifies the file system location where Binary Large Objects (BLOBs) are temporarily written to disk. (Inherited from IDTSPipeline100.)
	BufferManager	Gets the IDTSBufferManager100 object. (Inherited from IDTSPipeline100.)
	BufferTempStoragePath	Gets or sets the file system path used to temporarily cache buffer data. (Inherited from IDTSPipeline100.)
	ComponentMetaDataCollection	Gets the collection of data flow components in the task. (Inherited from IDTSPipeline100.)
	DefaultBufferMaxRows	Gets or sets the maximum number of rows the task allows in an IDTSBuffer100 buffer. (Inherited from IDTSPipeline100.)
	DefaultBufferSize	Gets or sets the default size of the IDTSBuffer100 objects created by the task. (Inherited from IDTSPipeline100.)
	EngineThreads	Gets or sets the number of threads the data flow task uses. (Inherited from IDTSPipeline100.)
	Events	Sets the events interface that the data flow and its components use to raise events during execution. (Inherited from IDTSPipeline100.)
	PathCollection	Gets the IDTSPathCollection100 collection for the data flow task. (Inherited from IDTSPipeline100.)
	PersistenceCustomPropertyCollection	Gets the collection of custom properties that have the specified persistence format. (Inherited from IDTSPipeline100.)
	RunInOptimizedMode	Gets or sets a value that specifies whether the data flow task runs in optimized mode. (Inherited from IDTSPipeline100.)
	VariableDispenser	Sets the IDTSVariableDispenser100 used to lock variables in the package for reading and writing. (Inherited from IDTSPipeline100.)

Top

Methods

	Name	Description
	GetNextPasteID	Gets the next available ID that the data flow task generates. (Inherited from IDTSPipeline100.)
	GetObjectByID(Int32)	Retrieves an object contained in the data flow task by using the ID of the object. (Inherited from IDTSPipeline100.)
	New()	Infrastructure. (Inherited from IDTSPipeline100.)

Top

Remarks

The MainPipe (displayed as the Data Flow Task in Business Intelligence Development Studio) is the managed implementation of the IDTSPipeline100 COM interface. It is the interface used from managed code when programmatically creating or modifying a data flow task in a Package. For an overview of the methods and properties available to this object, see the MainPipeClass documentation.

Examples

The following code example adds the MainPipe object to a Package and retrieves the MainPipe using the InnerObject property of the TaskHost.

Package p = new Package();
Executable e = p.Executables.Add("DTS.Pipeline.1");
TaskHost thMainPipe = e as TaskHost;
MainPipe dataFlowTask = thMainPipe.InnerObject as MainPipe;

See Also

Reference

Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace