Share via


ScriptBuffer.Item Property

Gets or sets the value of a column in the buffer by using its index in the array of buffer column indexes.

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

Syntax

'Declaration
Protected Default Property Item ( _
    ColumnIndex As Integer _
) As Object
    Get
    Set
'Usage
Dim ColumnIndex As Integer
Dim value As Object

value = Me(ColumnIndex)

Me(ColumnIndex) = value
protected Object this[
    int ColumnIndex
] { get; set; }
protected:
property Object^ default[int ColumnIndex] {
    Object^ get (int ColumnIndex);
    void set (int ColumnIndex, Object^ value);
}
member Item : Object with get, set
JScript supports the use of indexed properties, but not the declaration of new ones.

Parameters

Property Value

Type: System.Object
The value of a column in the buffer by using its index in the array of buffer column indexes.

Remarks

The Script component developer does not use the ScriptBuffer class directly, but indirectly, through the derived classes in the BufferWrapper project item that represent the component's input and outputs.

The developer does not have to use the Item property, because the derived classes provide typed accessors for each buffer column, with property names that correspond to the column names.

Examples

The following sample code from the autogenerated BufferWrapper project item demonstrates how the Script component implicitly uses the Item method to retrieve a column from the buffer.

    Public ReadOnly Property [City]() As String
        Get
            Return CType(Me(1), String)
        End Get
    End Property