DtsConvert.VarTypeFromTypeCode Method

Article
12/03/2008

Converts a system TypeCode to a Integration ServicesVariant data type. This method is not CLS-compliant.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Shared Function VarTypeFromTypeCode ( _
    typeCode As TypeCode _
) As UShort

public static ushort VarTypeFromTypeCode (
    TypeCode typeCode
)

public:
static unsigned short VarTypeFromTypeCode (
    TypeCode typeCode
)

public static UInt16 VarTypeFromTypeCode (
    TypeCode typeCode
)

public static function VarTypeFromTypeCode (
    typeCode : TypeCode
) : ushort

Parameters

typeCode
The system TypeCode to convert to the SSIS type.

Return Value

The SSIS type for the system TypeCode.

Remarks

For a list of the SSIS types, see Integration Services Data Types.

The following table shows the TypeCode and what SSIS Variant data type they are converted to.

System TypeCode	Variant Data Type
System.TypeCode.Empty	VT_EMPTY
System.TypeCode.DBNull	VT_NULL
System.TypeCode.Int16	VT_I2
System.TypeCode.Int32	VT_I4
System.TypeCode.Single	VT_R4
System.TypeCode.Double	VT_R8
System.TypeCode.Decimal	VT_CY
System.TypeCode.DateTime	VT_DATE
System.TypeCode.String	VT_BSTR
System.TypeCode.Object	VT_DISPATCH
System.TypeCode.Object	VT_ERROR
System.TypeCode.Boolean	VT_BOOL
System.TypeCode.Object	VT_VARIANT
System.TypeCode.Object	VT_UNKNOWN
System.TypeCode.Decimal	VT_DECIMAL
System.TypeCode.SByte	VT_I1
System.TypeCode.Byte	VT_UI1
System.TypeCode.UInt16	VT_UI2
System.TypeCode.UInt32	VT_UI4
System.TypeCode.Int64	VT_I8
System.TypeCode.UInt64	VT_UI8
System.TypeCode.Int16	VT_INT
System.TypeCode.UInt16	VT_UINT
System.TypeCode.Empty	VT_VOID

Example

The following example shows a pipeline component that overrides the RegisterEvents method and creates a custom event using the EventInfos collection, using the VarTypeFromTypeCode to create a reference type.

Public override void RegisterEvents()
{
string []parameters = new string[1]{"Parameter1"};
ushort []types = new ushort[1]{DtsConvert.VarTypeFromTypeCode(TypeCode.String)};
string []descriptions = new string [1]{"The first parameter."};

EventInfos.Add("OnPreExecute", "Fires when the PreExecute method runs.", false, ref parameters, ref types, ref descriptions);
}

Public Overrides  Sub RegisterEvents()
String ()parameters = New String(1)
{
    "Parameter1"
}

System.UInt16 ()types = New System.UInt16(1)
{
    DtsConvert.VarTypeFromTypeCode(TypeCode.String)
}

String ()descriptions = New String (1)
{
    "The first parameter."
}

 
EventInfos.Add("OnPreExecute", "Fires when the PreExecute method runs.", False,  parameters,  types,  descriptions)
End Sub

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