IDTSOutput90.Buffer Property

Article
12/03/2008

Gets the ID of the PipelineBuffer allocated for an IDTSOutput90 object.

Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in microsoft.sqlserver.dtspipelinewrap.dll)

Syntax

'Declaration
<ComAliasNameAttribute("Microsoft.SqlServer.Dts.Pipeline.Wrapper.DTP_HBUFFERTYPE")> _
<DispIdAttribute(103)> _
ReadOnly Property Buffer As Integer

[ComAliasNameAttribute("Microsoft.SqlServer.Dts.Pipeline.Wrapper.DTP_HBUFFERTYPE")] 
[DispIdAttribute(103)] 
int Buffer { get; }

[ComAliasNameAttribute(L"Microsoft.SqlServer.Dts.Pipeline.Wrapper.DTP_HBUFFERTYPE")] 
[DispIdAttribute(103)] 
property int Buffer {
    int get ();
}

/** @property */
/** @attribute DispIdAttribute(103) */ 
int get_Buffer ()

DispIdAttribute(103) 
function get Buffer () : int

Property Value

The integer ID of the PipelineBuffer assigned to the IDTSOutput90 object.

Remarks

This run-time property is primarily used as a parameter for the FindColumnByLineageID method of the BufferManager property to locate a column in a PipelineBuffer.

Example

The following code example locates the output columns in a buffer using FindColumnByLineageID. The indexes of the columns are stored in an internal member array so they can be accessed using either the PrimeOutput method or the ProcessInput method.

int []columnIndex;
public override void PreExecute()
{
    IDTSOutput90 output = ComponentMetaData.OutputCollection[0];

    columnIndex = new int[output.OutputColumnCollection.Count];

    for(int x=0; x< output.OutputColumnCollection.Count; x++)
    {
        IDTSOutputColumn90 col = output.OutputColumnCollection[x];
        columnIndex[x] = BufferManager.FindColumnByLineageID( output.Buffer,col.LineageID);
    }
}

Private columnIndex As Integer() 

Public  Overrides Sub PreExecute() 
 Dim output As IDTSOutput90 = ComponentMetaData.OutputCollection(0) 
 columnIndex = New Integer(output.OutputColumnCollection.Count - 1) {} 
 Dim x As Integer = 0 
 While x < output.OutputColumnCollection.Count 
   Dim col As IDTSOutputColumn90 = output.OutputColumnCollection(x) 
   columnIndex(x) = BufferManager.FindColumnByLineageID(output.Buffer, col.LineageID) 
   x -= 1 
 End While 
End Sub

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