• Article

PipelineBuffer.GetUInt16 Method

Gets the ushort value stored in the buffer column.

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Function GetUInt16 ( _
    columnIndex As Integer _
) As UShort
'Usage
Dim instance As PipelineBuffer
Dim columnIndex As Integer
Dim returnValue As UShort

returnValue = instance.GetUInt16(columnIndex)

[CLSCompliantAttribute(false)]
public ushort GetUInt16(
    int columnIndex
)

[CLSCompliantAttribute(false)]
public:
unsigned short GetUInt16(
    int columnIndex
)

[<CLSCompliantAttribute(false)>]
member GetUInt16 : 
        columnIndex:int -> uint16 

public function GetUInt16(
    columnIndex : int
) : ushort

Parameters

  • columnIndex
    Type: System.Int32
    The index of the column in the buffer row.

Return Value

Type: System.UInt16
The ushort stored in the buffer column.

Remarks

This method works with the DT_UI2 data type in Integration Services.

If the buffer column DataType is not DT_UI2, the PipelineBuffer produces an UnsupportedBufferDataTypeException.

If the value of the column is null, the PipelineBuffer produces a ColumnIsNullException. You can check for null by calling the IsNull method.

For a complete list of Integration Services data types and the corresponding Get and Set methods of the PipelineBuffer class to use with each type, see Working with Data Types in the Data Flow.