PipelineBuffer.GetString(Int32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline

Assembly:: Microsoft.SqlServer.PipelineHost.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the string stored in the buffer column.

public:
 System::String ^ GetString(int columnIndex);

public string GetString (int columnIndex);

member this.GetString : int -> string

Public Function GetString (columnIndex As Integer) As String

Parameters

columnIndex: Int32

The index of the column in the buffer row.

Returns

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.

Applies to