PipelineBuffer.GetColumnInfo(Int32) PipelineBuffer.GetColumnInfo(Int32) PipelineBuffer.GetColumnInfo(Int32) Method

Definition

Important

This API is not CLS-compliant.

Retrieves the BufferColumn structure for a PipelineBuffer column.

public:
 Microsoft::SqlServer::Dts::Pipeline::BufferColumn GetColumnInfo(int columnIndex);
[System.CLSCompliant(false)]
public Microsoft.SqlServer.Dts.Pipeline.BufferColumn GetColumnInfo (int columnIndex);
Public Function GetColumnInfo (columnIndex As Integer) As BufferColumn
Parameters
columnIndex
Int32 Int32 Int32

The index of the column whose BufferColumn structure is retrieved.

Returns

The BufferColumn structure of the specified PipelineBuffer column.

Remarks

The BufferColumn contains information about the data stored in a PipelineBuffer column. This information can be used to prevent exceptions that might occur when assigning data to the buffer column. For example, columns with a fixed length such as the DT_STR, DT_TEXT, DT_WSTR, and DT_BYTES data types will fail if the data length is greater than the MaxLength of the BufferColumn.

Applies to