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)

[GuidAttribute("BE3F920C-1F7B-4B2A-B593-6F6C84072D82")]
[CoClassAttribute(typeof(MainPipeClass))]
public interface MainPipe : IDTSPipeline100

NameDescription
System_CAPS_pubpropertyAutoGenerateIDForNewObjects

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.)

System_CAPS_pubpropertyBLOBTempStoragePath

Gets or sets a value that specifies the file system location where Binary Large Objects (BLOBs) are temporarily written to disk.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyBufferManager

Gets the IDTSBufferManager100 object.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyBufferTempStoragePath

Gets or sets the file system path used to temporarily cache buffer data.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyComponentMetaDataCollection

Gets the collection of data flow components in the task.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyDefaultBufferMaxRows

Gets or sets the maximum number of rows the task allows in an IDTSBuffer100 buffer.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyDefaultBufferSize

Gets or sets the default size of the IDTSBuffer100 objects created by the task.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyEnableCacheUpdate

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets whether the IDTSPipeline100 enabled the updating of cache.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyEnableDisconnectedColumns

Gets or sets a value that indicates whether the data flow task enables the disconnected columns in the main pipe.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyEngineThreads

Gets or sets the number of threads the data flow task uses.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyEvents

Sets the events interface that the data flow and its components use to raise events during execution.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyIsSavingXml

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets whether the IDTSPipeline100 is saving xml.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyPathCollection

Gets the IDTSPathCollection100 collection for the data flow task.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyPersistenceCustomPropertyCollection[DTSPersistenceFormat]

Gets the collection of custom properties that have the specified persistence format.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyRunInOptimizedMode

Gets or sets a value that specifies whether the data flow task runs in optimized mode.(Inherited from IDTSPipeline100.)

System_CAPS_pubpropertyVariableDispenser

Sets the IDTSVariableDispenser100 used to lock variables in the package for reading and writing.(Inherited from IDTSPipeline100.)

NameDescription
System_CAPS_pubmethodGetNextPasteID()

Gets the next available ID that the data flow task generates.(Inherited from IDTSPipeline100.)

System_CAPS_pubmethodGetObjectByID(Int32)

Retrieves an object contained in the data flow task by using the ID of the object.(Inherited from IDTSPipeline100.)

System_CAPS_pubmethodNew()

This API supports the product infrastructure and is not intended to be used directly from your code. Specifies a new instance of IDTSPipeline100 class.(Inherited from IDTSPipeline100.)

System_CAPS_pubmethodUpdateCacheOnInputColumns()

This API supports the product infrastructure and is not intended to be used directly from your code. Updates the cache on input column of IDTSPipeline100.(Inherited from IDTSPipeline100.)

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.

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;
Return to top
Show: