PipelineBuffer.GetString Method

Article
12/03/2008

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

public string GetString (
    int columnIndex
)

public:
String^ GetString (
    int columnIndex
)

public String GetString (
    int columnIndex
)

public function GetString (
    columnIndex : int
) : String

Parameters

columnIndex
The index of the column in the buffer row.

Return Value

The string stored in the buffer column.

Remarks

If the buffer column DataType is not DT_STR or DT_WSTR, 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.

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