IDTSBuffer100 Interface

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:

Microsoft.SqlServer.DTSPipelineWrap.dll

Represents an in-memory, two-dimensional storage object that contains rows and columns.

public interface class IDTSBuffer100

[System.Runtime.InteropServices.ComConversionLoss]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
[System.Runtime.InteropServices.Guid("00D6D48D-BB09-4C07-81E3-83EFBA86ADC0")]
public interface IDTSBuffer100

[<System.Runtime.InteropServices.ComConversionLoss>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
[<System.Runtime.InteropServices.Guid("00D6D48D-BB09-4C07-81E3-83EFBA86ADC0")>]
type IDTSBuffer100 = interface

Public Interface IDTSBuffer100

Attributes

ComConversionLossAttribute GuidAttribute InterfaceTypeAttribute

Remarks

The IDTSBuffer100 is an in-memory, two-dimensional data structure that contains rows and columns. Each column in a buffer has information that describes its data type, its offset location in memory in the row, its maximum size, and the lineage ID of the column in a component.

The data in each column is accessed either by using its offset as defined by the DTP_BUFFCOL structure, or by using the SetData and GetData methods, in which the data location of the column in the buffer is defined by handles to its row and column.

There are two types of buffers, private and public, which are created by the IDTSBufferManager100. Private buffers are created when requested by a data flow component and are used internally by the component. Public buffers are provided to the components in the data flow graph and filled and manipulated before arriving at the destination. Public buffers are created, managed, and destroyed by the IDTSBufferManager100.

Buffers are identified by their handles and are 1-based, which means they cannot have a value of zero or null unless they are invalid.

Managed component developers do not typically use the IDTSBuffer100 object unless they intend to create private buffers and implement the code necessary to interoperate between managed code and native code. Instead, they use the managed PipelineBuffer class.

Methods

AddBLOBData(Int32, Int32, Byte, UInt32)	Appends byte data to a column in an IDTSBuffer100.
AddRow(IntPtr)	Adds a new row to an IDTSBuffer100 object.
Clone(IDTSComponentMetaData100)	Creates a private copy of an IDTSBuffer100 object.
DirectErrorRow(Int32, Int32, Int32, Int32)	Sends a row in an IDTSBuffer100 object to an IDTSOutput100 whose IsErrorOut property is true.
DirectRow(Int32, Int32)	Sends a row in an IDTSBuffer100 to an IDTSOutput100.
GetBLOBData(Int32, Int32, UInt32, Byte, UInt32, UInt32)	Retrieves an array of bytes from a binary large object (BLOB) stored in a column of a IDTSBuffer100.
GetBLOBLength(Int32, Int32, UInt32)	Gets the number of bytes contained in a column in an IDTSBuffer100.
GetBLOBObject(Int32, Int32)	Gets an IDTSBLOBObject100 that is used to read and write the bytes in a column in an IDTSBuffer100.
GetBLOBStream(Int32, Int32)	Gets an IStream interface used to access the binary large object (BLOB) stored in a column in an IDTSBuffer100.
GetBoundaryInfo(UInt32, UInt32)	Gets the number of columns and the maximum number of rows that an IDTSBuffer100 can hold.
GetColumnCount()	Gets the number of columns in an IDTSBuffer100.
GetColumnInfo(Int32, DTP_BUFFCOL)	Gets the DTP_BUFFCOL structure for the specified column in an IDTSBuffer100.
GetData(Int32, Int32)	Retrieves the data stored in a specified row and column of a IDTSBuffer100.
GetDataByRef(Int32, Int32)	(Feature deprecated, see Remarks.) Gets a pointer to the data stored in a column in an IDTSBuffer100.
GetFlatMemory()	Gets a pointer to the bytes stored by an IDTSBuffer100.
GetID()	Retrieves the ID of a buffer.
GetManager()	Gets a buffer manager.
GetRowCount()	Gets the number of rows stored in an IDTSBuffer100.
GetRowDataBytes(Int32, Int32, IntPtr)	(Feature deprecated, see Remarks.) Gets a pointer to the start of a row in an IDTSBuffer100.
GetRowStarts(UInt32, IntPtr)	(Feature deprecated, see Remarks.) Use the GetData(Int32, Int32) or GetBLOBData(Int32, Int32, UInt32, Byte, UInt32, UInt32) method instead of the GetRowStarts(UInt32, IntPtr) method.
GetStatus(Int32, Int32, UInt32)	Retrieves the status information of a column in an IDTSBuffer100.
GetType()	Gets the handle of a buffer type.
IsEndOfRowset()	Specifies whether an IDTSBuffer100 has reached the end of its collection of rows.
IsNull(Int32, Int32, Boolean)	Checks whether a specified column is null.
LockData()	Locks the data in an IDTSBuffer100.
MoveRow(Int32, Int32)	Moves a row in an IDTSBuffer100 to a new location.
PrepareDataStatusForInsert(Int32)	Sets the status value of the columns in a range of rows.
RemoveRow(Int32)	Deletes a row from an IDTSBuffer100.
ResetBLOBData(Int32, Int32)	Deletes the bytes stored in a column in an IDTSBuffer100.
SetBLOBFromObject(Int32, Int32, IDTSBLOBObject100)	Assigns the data contained in an IDTSBLOBObject100 to a column in an IDTSBuffer100.
SetBLOBFromStream(Int32, Int32, ISequentialStream)	Assigns data to a binary large object (BLOB) column from a sequential stream.
SetData(Int32, Int32, DTP_VARIANT)	Assigns data to a column in an IDTSBuffer100.
SetEndOfRowset()	Notifies an IDTSBufferManager100 that the component has finished adding rows to an output IDTSBuffer100 object.
SetErrorInfo(Int32, Int32, Int32, Int32)	Sets the error information for a row.
SetStatus(Int32, Int32, UInt32)	Sets the status information of a column in an IDTSBuffer100.
SwapRows(Int32, Int32)	Swaps the location of two rows in an IDTSBuffer100.
UnlockData()	Unlocks the data in an IDTSBuffer100 object.