IDTSBufferManager100.RegisterBufferType Method

Registers a buffer type with an IDTSBufferManager100.

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

Syntax

'Declaration
Function RegisterBufferType ( _
    cCols As Integer, _
    ByRef rgCols As DTP_BUFFCOL, _
    lMaxRows As Integer, _
    dwCreationFlags As UInteger _
) As Integer
'Usage
Dim instance As IDTSBufferManager100
Dim cCols As Integer
Dim rgCols As DTP_BUFFCOL
Dim lMaxRows As Integer
Dim dwCreationFlags As UInteger
Dim returnValue As Integer

returnValue = instance.RegisterBufferType(cCols, _
    rgCols, lMaxRows, dwCreationFlags)
int RegisterBufferType(
    int cCols,
    ref DTP_BUFFCOL rgCols,
    int lMaxRows,
    uint dwCreationFlags
)
int RegisterBufferType(
    [InAttribute] int cCols, 
    [InAttribute] DTP_BUFFCOL% rgCols, 
    [InAttribute] int lMaxRows, 
    [InAttribute] unsigned int dwCreationFlags
)
abstract RegisterBufferType : 
        cCols:int * 
        rgCols:DTP_BUFFCOL byref * 
        lMaxRows:int * 
        dwCreationFlags:uint32 -> int 
function RegisterBufferType(
    cCols : int, 
    rgCols : DTP_BUFFCOL, 
    lMaxRows : int, 
    dwCreationFlags : uint
) : int

Parameters

  • cCols
    Type: System.Int32
    The number of columns in the buffer type definition.
  • lMaxRows
    Type: System.Int32
    The maximum number of rows that the buffer can hold.

Return Value

Type: System.Int32
An unsigned integer that contains the ID of the buffer type.

Remarks

The buffer manager maintains a list of buffer types. Each buffer type definition contains the number of columns, the data type properties of each column, whether space is allocated that holds status information for the column, and how the columns are initialized when a new instance of the buffer type is created. This method is used to register a new buffer type with the manager. Once the new buffer type has been defined, the returned ID of the buffer type is used when calling the CreateBuffer method. If an existing buffer definition is found that matches the parameters of this method, then its ID is returned. Otherwise, a new definition is created.