IDTSDesigntimeComponent100.SetUsageType Method

Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.

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

Syntax

'Declaration
Function SetUsageType ( _
    lInputID As Integer, _
    pIDTSVirtualInputObject As IDTSVirtualInput100, _
    lLineageID As Integer, _
    eUsageType As DTSUsageType _
) As IDTSInputColumn100
'Usage
Dim instance As IDTSDesigntimeComponent100 
Dim lInputID As Integer 
Dim pIDTSVirtualInputObject As IDTSVirtualInput100 
Dim lLineageID As Integer 
Dim eUsageType As DTSUsageType 
Dim returnValue As IDTSInputColumn100 

returnValue = instance.SetUsageType(lInputID, _
    pIDTSVirtualInputObject, lLineageID, _
    eUsageType)

IDTSInputColumn100 SetUsageType(
    int lInputID,
    IDTSVirtualInput100 pIDTSVirtualInputObject,
    int lLineageID,
    DTSUsageType eUsageType
)

IDTSInputColumn100^ SetUsageType(
    [InAttribute] int lInputID, 
    [InAttribute] IDTSVirtualInput100^ pIDTSVirtualInputObject, 
    [InAttribute] int lLineageID, 
    [InAttribute] DTSUsageType eUsageType
)

abstract SetUsageType : 
        lInputID:int * 
        pIDTSVirtualInputObject:IDTSVirtualInput100 * 
        lLineageID:int * 
        eUsageType:DTSUsageType -> IDTSInputColumn100

function SetUsageType(
    lInputID : int, 
    pIDTSVirtualInputObject : IDTSVirtualInput100, 
    lLineageID : int, 
    eUsageType : DTSUsageType
) : IDTSInputColumn100

Parameters

• lInputID
  Type: System.Int32
  The ID of the IDTSInput100.

• pIDTSVirtualInputObject
  Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSVirtualInput100
  The IDTSVirtualInput100 object that contains the virtual input column and that is used to map the IDTSInputColumn100 object.

• lLineageID
  Type: System.Int32
  The LineageID property of the IDTSVirtualInputColumn100 object.

• eUsageType
  Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.DTSUsageType
  A value from the DTSUsageType enumeration that is assigned to the IDTSInputColumn100.

Return Value

Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSInputColumn100
The IDTSInputColumn100 object whose UsageType is set.

Remarks

SetUsageType is called when a column from the IDTSVirtualInputColumnCollection100 is selected for a component. If the usageType is UT_READONLY or UT_READWRITE, a new input column is created for the component that reflects the IDTSVirtualInputColumn100 specified by the lLineageID parameter. If usageType is UT_IGNORED and the column exists in the collection, the column is removed and nulla null reference (Nothing in Visual Basic) is returned.

See Also

Reference

IDTSDesigntimeComponent100 Interface

Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace