PipelineBuffer.Item Property (Int32)

Applies To: SQL Server 2016 Preview

Gets the data stored in a buffer column.

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

Syntax

public object this[
    int columnIndex
] { get; set; }

public:
property Object^ default[
    int columnIndex
] {
    Object^ get(int columnIndex);
    void set(int columnIndex, Object^ value);
}

member Item : 
        columnIndex:int -> Object with get, set

Public Property Item (
    columnIndex As Integer
) As Object

Parameters

• columnIndex
  Type: System.Int32

  The index of the column in the buffer row.

Property Value

Type: System.Object

The data stored in the buffer column as an object.

Remarks

The value stored in a buffer column can be accessed by using one of the data type accessor methods, such as the GetString method, or it can be accessed directly by using array access notation. Accessing a column in the PipelineBuffer by using the Item method is slower than using a data type accessor method because the PipelineBuffer detects the data type stored in the column and then calls the data type accessor method.

Buffer columns containing binary large objects (BLOB) data cannot be retrieved using the array access notation because the amount of data stored in the BLOB column may exceed the available memory. Instead, the GetBlobData method should be used.

See Also

PipelineBuffer Class
Microsoft.SqlServer.Dts.Pipeline Namespace

Return to top