Share via


DTSBufferManagerClass.RegisterBufferType Method

Definition

Registers a buffer type with the IDTSBufferManager100.

public:
 virtual int RegisterBufferType(int cCols, Microsoft::SqlServer::Dts::Pipeline::Wrapper::DTP_BUFFCOL % rgCols, int lMaxRows, System::UInt32 dwCreationFlags) = Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSBufferManager100::RegisterBufferType;
public virtual int RegisterBufferType (int cCols, ref Microsoft.SqlServer.Dts.Pipeline.Wrapper.DTP_BUFFCOL rgCols, int lMaxRows, uint dwCreationFlags);
abstract member RegisterBufferType : int * DTP_BUFFCOL * int * uint32 -> int
override this.RegisterBufferType : int * DTP_BUFFCOL * int * uint32 -> int
Public Overridable Function RegisterBufferType (cCols As Integer, ByRef rgCols As DTP_BUFFCOL, lMaxRows As Integer, dwCreationFlags As UInteger) As Integer

Parameters

cCols
Int32

The number of columns in the buffer type definition.

rgCols
DTP_BUFFCOL

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

lMaxRows
Int32

The maximum number of rows that the buffer can hold.

dwCreationFlags
UInt32

A combination of the values in the DTSBufferFlags.

Returns

An unsigned integer that contains the ID of the buffer type.

Implements

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.

Applies to