DTSBufferManagerClass.RegisterBufferType Method

Registers a buffer type with the IDTSBufferManager90.

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

Syntax

'Declaration
<DispIdAttribute(101)> _
Public Overridable Function RegisterBufferType ( _
    <InAttribute> cCols As Integer, _
    <InAttribute> ByRef rgCols As DTP_BUFFCOL, _
    <InAttribute> lMaxRows As Integer, _
    <InAttribute> dwCreationFlags As UInteger _
) As Integer Implements IDTSBufferManager90.RegisterBufferType

[DispIdAttribute(101)] 
public virtual int IDTSBufferManager90.RegisterBufferType (
    [InAttribute] int cCols,
    [InAttribute] ref DTP_BUFFCOL rgCols,
    [InAttribute] int lMaxRows,
    [InAttribute] uint dwCreationFlags
)

[DispIdAttribute(101)] 
public:
virtual int RegisterBufferType (
    [InAttribute] int cCols, 
    [InAttribute] DTP_BUFFCOL% rgCols, 
    [InAttribute] int lMaxRows, 
    [InAttribute] unsigned int dwCreationFlags
) = IDTSBufferManager90::RegisterBufferType

J# supports the use of explicit interface implementations, but not the declaration of new ones.

JScript does not support passing value-type arguments by reference.

Parameters

cCols
The number of columns in the buffer type definition.

rgCols
A pointer to the collection of DTP_BUFFCOL structures that describe each of the columns in the buffer type definition.

lMaxRows
The maximum number of rows that the buffer can hold.

dwCreationFlags
A combination of the values in the DTSBufferFlags.

Return Value

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 a buffer type has been defined, the returned ID of the buffer type is used when calling CreateBuffer. If a buffer definition is found that matches the parameters of this method, then its ID is returned. Otherwise, a new definition is created.

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