CManagedComponentWrapperClass.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)> _
Public Overridable Function SetUsageType ( _
    <InAttribute> lInputID As Integer, _
    <InAttribute> pIDTSVirtualInputObject As IDTSVirtualInput90, _
    <InAttribute> lLineageID As Integer, _
    <InAttribute> eUsageType As DTSUsageType _
) As IDTSInputColumn90 Implements IDTSDesigntimeComponent90.SetUsageType

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

[DispIdAttribute(16)] 
public:
virtual IDTSInputColumn90^ SetUsageType (
    [InAttribute] int lInputID, 
    [InAttribute] IDTSVirtualInput90^ pIDTSVirtualInputObject, 
    [InAttribute] int lLineageID, 
    [InAttribute] DTSUsageType eUsageType
) = IDTSDesigntimeComponent90::SetUsageType

J# supports the use of explicit interface implementations, but not the declaration of new ones.

JScript supports the use of explicit interface implementations, but not the declarations of new ones.

Parameters

lInputID
The ID of the IDTSInput90 object.

pIDTSVirtualInputObject
The IDTSVirtualInput90 object.

lLineageID
The LineageID of the IDTSVirtualInputColumn90 object.

eUsageType
The usage type of the input column.

Return Value

The IDTSInputColumn90 whose usage type is set, or null if the column was removed from the collection.

Remarks

This method is used to select the columns from the upstream component in the data flow graph that are used by the component. Call this method to add or remove an IDTSInputColumn90 from the InputColumnCollection of the component. It also specifies whether the component has read-only access to the column or if it can overwrite the values of the column during execution.

If eusageType is UT_READONLY or UT_READWRITE, the component adds the column to its input column collection and provides the column to the data flow engine during execution. If UT_IGNORED is specified, and the column has previously been added to the collection, the column is removed.

Example

The following code example shows how SetUsageType is used to select the columns from the upstream component that are used by the component. The example assumes that the package has already been created or loaded, and that the data flow task and components have been added to the package.

IDTSComponentMetaData90 md = dataFlow.ComponentMetaDataCollection[1];
CManagedComponentWrapper wrp = md.Instantiate();
IDTSInput90 input = md.InputCollection[0];
IDTSVirtualInput90 vInput = input.GetVirtualInput();

foreach(IDTSVirtualInputColumn90 vCol in vInput.VirtualInputColumnCollection)
{
    wrp.SetUsageType(input.ID,vInput,vCol.LineageID,DTSUsageType.UT_READWRITE);
}

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