IDTSVirtualInput100 Interface

 

Represents the columns available to a component from the upstream component.

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

[TypeLibTypeAttribute(TypeLibTypeFlags::FDual | TypeLibTypeFlags::FDispatchable)]
[GuidAttribute("FECB6DEB-654E-43EE-B87D-35F88555172E")]
public interface class IDTSVirtualInput100 : IDTSObject100

NameDescription
System_CAPS_pubpropertyDescription

Gets or sets the description of an IDTSVirtualInput100 object.

System_CAPS_pubpropertyID

Gets or sets the ID of a virtual input object.

System_CAPS_pubpropertyIdentificationString

Gets a string that uniquely identifies the IDTSVirtualInput100.

System_CAPS_pubpropertyIsSorted

Gets a value that indicates whether the virtual input columns in the IDTSVirtualInput100 are sorted.

System_CAPS_pubpropertyName

Gets or sets the name of an IDTSVirtualInput100.

System_CAPS_pubpropertyObjectType

Gets the DTSObjectType of an IDTSVirtualInput100.

System_CAPS_pubpropertySourceLocale

Gets the locale ID (LCID) of the source of the IDTSVirtualInput100.

System_CAPS_pubpropertyVirtualInputColumnCollection

Gets the IDTSVirtualInputColumnCollection100 of an IDTSVirtualInput100.

NameDescription
System_CAPS_pubmethodSetUsageType(Int32, DTSUsageType)

Maps a virtual input column object and sets its usage type.

The IDTSVirtualInput100 is retrieved by calling the GetVirtualInput method of an IDTSInput100 object. The VirtualInputColumnCollection property contains the columns that are available from the upstream components in the graph.

When programmatically building a data flow task, the virtual columns are selected for a component by calling the SetUsageType method of the CManagedComponentWrapperClass.

Developers writing custom data flow components use the virtual input to discover the available upstream columns, and, depending on the component, to add columns to the input based on the columns in the virtual collection.

Because the virtual input is a reflection of upstream columns, modifications to the virtual input or the columns in the virtual input collection do not have any impact on the IDTSOutput100 itself.

The following code example shows how to use the virtual input to select the columns used by a component when programmatically building the data flow task.

No code example is currently available or this language may not be supported.

The following code example shows a custom data flow component that selects all of the DT_STR columns from the virtual input when the input is connected to a path.

No code example is currently available or this language may not be supported.
Return to top
Show: