MainPipe Interface

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:

Microsoft.SqlServer.DTSPipelineWrap.dll

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

public interface class MainPipe : Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSPipeline100

[System.Runtime.InteropServices.CoClass(typeof(Microsoft.SqlServer.Dts.Pipeline.Wrapper.MainPipeClass))]
[System.Runtime.InteropServices.Guid("7068DEA5-9977-4EF9-BB5A-29D1CA3FA415")]
public interface MainPipe : Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSPipeline100

[<System.Runtime.InteropServices.CoClass(typeof(Microsoft.SqlServer.Dts.Pipeline.Wrapper.MainPipeClass))>]
[<System.Runtime.InteropServices.Guid("7068DEA5-9977-4EF9-BB5A-29D1CA3FA415")>]
type MainPipe = interface
    interface IDTSPipeline100

Public Interface MainPipe
Implements IDTSPipeline100

Derived

Microsoft.SqlServer.Dts.Pipeline.Wrapper.MainPipeClass

Attributes

CoClassAttribute GuidAttribute

Implements

IDTSObjectModel100 IDTSPipeline100

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;  

Remarks

The MainPipe (displayed as the Data Flow Task in SQL Server Data Tools (SSDT)) 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.

Properties

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)
EnableCacheUpdate	Gets or sets whether the IDTSPipeline100 enabled the updating of cache. (Inherited from IDTSPipeline100)
EnableDisconnectedColumns	Gets or sets a value that indicates whether the data flow task enables the disconnected columns in the main pipe. (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)
IsSavingXml	Gets or sets whether the IDTSPipeline100 is saving xml. (Inherited from IDTSPipeline100)
PathCollection	Gets the IDTSPathCollection100 collection for the data flow task. (Inherited from IDTSPipeline100)
PersistenceCustomPropertyCollection[DTSPersistenceFormat]	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)

Methods

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()	Specifies a new instance of IDTSPipeline100 class. (Inherited from IDTSPipeline100)
UpdateCacheOnInputColumns()	Updates the cache on input column of IDTSPipeline100. (Inherited from IDTSPipeline100)