IDTSInput100 Interface

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:

Microsoft.SqlServer.DTSPipelineWrap.dll

Contains the collection of columns that represents the data provided to a component in the form of PipelineBuffer objects at run time.

public interface class IDTSInput100 : Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSObject100

[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
[System.Runtime.InteropServices.Guid("89E6FA94-7A4A-480E-BD86-4767AF244C19")]
public interface IDTSInput100 : Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSObject100

[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
[<System.Runtime.InteropServices.Guid("89E6FA94-7A4A-480E-BD86-4767AF244C19")>]
type IDTSInput100 = interface
    interface IDTSObject100

Public Interface IDTSInput100
Implements IDTSObject100

Attributes

GuidAttribute TypeLibTypeAttribute

Implements

IDTSObject100

Examples

The following code example demonstrates a component adding an input to its collection in the ProvideComponentProperties method.

using System;  
using Microsoft.SqlServer.Dts.Pipeline;  
public class DtsSampleComponent : PipelineComponent  
{   
public override void ProvideComponentProperties()  
{  
IDTSInput100 input = ComponentMetaData.InputCollection.New();  
input.Name = "SampleComponentInput0";  
}  
}  

Imports System   
Imports Microsoft.SqlServer.Dts.Pipeline   

Public Class DtsSampleComponent   
Inherits PipelineComponent   

 Public Overloads Overrides Sub ProvideComponentProperties()   
   Dim input As IDTSInput100 = ComponentMetaData.InputCollection.New   
   input.Name = "SampleComponentInput0"   
 End Sub   
End Class  

Remarks

The IDTSInput100 object represents a connection point between two components, and, when connected to the IDTSOutput100 of an upstream component, establishes the flow of data between components. A connection between an IDTSInput100 and an IDTSOutput100 is established through the IDTSPath100 object. The input represents the EndPoint property of the IDTSPath100 object.

At design time, the columns in the IDTSOutputColumnCollection100 of the output that the input is connected to are selected for use by the component. These columns are then available to the component during component execution.

Properties

AreInputColumnsAssociatedWithOutputColumns	Gets whether the input columns are associated with output columns.
Buffer	Gets the ID of a PipelineBuffer that is allocated for an IDTSInput100 object and provided to the component in the ProcessInput(Int32, PipelineBuffer) method.
BufferBase	Gets the abstract base class of the IDTSInput100.
Component	Gets the IDTSComponentMetaData100 object of an IDTSInput100 object.
CustomPropertyCollection	Gets the IDTSCustomPropertyCollection100 object of an IDTSInput100 object.
Dangling	Gets or sets a value that notifies the data flow engine that the input can be unattached.
Description	Gets or sets the description of an IDTSInput100 object.
ErrorOrTruncationOperation	Gets or sets a String that specifies the types of errors or truncations that can occur while processing a PipelineBuffer row.
ErrorRowDisposition	Gets or sets a value from a DTSRowDisposition enumeration that specifies how the component will handle error conditions that occur when processing a row from a PipelineBuffer object.
ExternalMetadataColumnCollection	Gets the collection of columns that reflects the columns in an external data source, which are used to validate an IDTSInputColumnCollection100 when the component is not connected to the external data source.
HasSideEffects	Gets or sets a value that indicates whether a data flow component should be removed or remain in the execution plan of a data flow task when its output is not attached to a downstream component and when the RunInOptimizedMode property of the Data Flow task is true.
ID	Gets or sets the identifier of an IDTSInput100 object.
IdentificationString	Gets a String that uniquely identifies an IDTSInput100 object.
InputColumnCollection	Gets the IDTSInputColumnCollection100 of an IDTSInput100 object.
IsAttached	Gets a value that indicates if an IDTSInput100 is attached to an upstream component through an IDTSPath100 object.
IsSorted	Gets a value that indicates whether the columns in an IDTSInputColumnCollection100 are sorted.
Name	Gets or sets the name of an IDTSInput100 object.
ObjectType	Gets the DTSObjectType of an IDTSInput100 object.
SourceLocale	Gets the locale for an IDTSInput100 object.
TruncationRowDisposition	Gets or sets a value that determines how the component handles truncations that occur while processing rows from a PipelineBuffer.

Methods

GetVirtualInput()	Gets the IDTSVirtualInput100 object of an IDTSInput100 object.
SuggestNameBasedLineageIDMappings(Int32[], Int32[])	Suggests a name based lineage identifier mappings.