IDTSDesigntimeComponent90.SetUsageType Method

Article
12/03/2008

Creates an IDTSInputColumn90 object in the IDTSInputColumnCollection90 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
<DispIdAttribute(16)> _
Function SetUsageType ( _
    <InAttribute> lInputID As Integer, _
    <InAttribute> pIDTSVirtualInputObject As IDTSVirtualInput90, _
    <InAttribute> lLineageID As Integer, _
    <InAttribute> eUsageType As DTSUsageType _
) As IDTSInputColumn90

[DispIdAttribute(16)] 
IDTSInputColumn90 SetUsageType (
    [InAttribute] int lInputID,
    [InAttribute] IDTSVirtualInput90 pIDTSVirtualInputObject,
    [InAttribute] int lLineageID,
    [InAttribute] DTSUsageType eUsageType
)

[DispIdAttribute(16)] 
IDTSInputColumn90^ SetUsageType (
    [InAttribute] int lInputID, 
    [InAttribute] IDTSVirtualInput90^ pIDTSVirtualInputObject, 
    [InAttribute] int lLineageID, 
    [InAttribute] DTSUsageType eUsageType
)

/** @attribute DispIdAttribute(16) */ 
IDTSInputColumn90 SetUsageType (
    /** @attribute InAttribute() */ int lInputID, 
    /** @attribute InAttribute() */ IDTSVirtualInput90 pIDTSVirtualInputObject, 
    /** @attribute InAttribute() */ int lLineageID, 
    /** @attribute InAttribute() */ DTSUsageType eUsageType
)

DispIdAttribute(16) 
function SetUsageType (
    lInputID : int, 
    pIDTSVirtualInputObject : IDTSVirtualInput90, 
    lLineageID : int, 
    eUsageType : DTSUsageType
) : IDTSInputColumn90

Parameters

lInputID
The ID of the IDTSInput90.

pIDTSVirtualInputObject
The IDTSVirtualInput90 object that contains the virtual input column and that is used to map the IDTSInputColumn90 object.

lLineageID
The LineageID property of the IDTSVirtualInputColumn90 object.

eUsageType
A value from the DTSUsageType enumeration that is assigned to the IDTSInputColumn90.

Return Value

The IDTSInputColumn90 object whose UsageType is set.

Remarks

SetUsageType is called when a column from the IDTSVirtualInputColumnCollection90 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 IDTSVirtualInputColumn90 specified by the lLineageID parameter. If usageType is UT_IGNORED and the column exists in the collection, the column is removed and null is returned.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms