Share via

  • Article

PipelineBuffer.GetString Method

Gets the string stored in the buffer column.

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

Syntax

'Declaration
Public Function GetString ( _
    columnIndex As Integer _
) As String
'Usage
Dim instance As PipelineBuffer
Dim columnIndex As Integer
Dim returnValue As String

returnValue = instance.GetString(columnIndex)

public string GetString(
    int columnIndex
)

public:
String^ GetString(
    int columnIndex
)

member GetString : 
        columnIndex:int -> string 

public function GetString(
    columnIndex : int
) : String

Parameters

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

Return Value

Type: System.String
The string stored in the buffer column.

Remarks

This method works with the following Integration Services data types:

If the value being assigned to the buffer column is not a string or the buffer column DataType is not a DT_STR, DT_WSTR, DT_TEXT, or DT_NTEXT, an UnsupportedBufferDataTypeException occurs.

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.