Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Retrieves the BufferColumn structure for a PipelineBuffer column.
This API is not CLS-compliant.
Namespace: Microsoft.SqlServer.Dts.Pipeline
Assembly: Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)
Syntax
'Declaration
<CLSCompliantAttribute(False)> _
Public Function GetColumnInfo ( _
columnIndex As Integer _
) As BufferColumn
'Usage
Dim instance As PipelineBuffer
Dim columnIndex As Integer
Dim returnValue As BufferColumn
returnValue = instance.GetColumnInfo(columnIndex)
[CLSCompliantAttribute(false)]
public BufferColumn GetColumnInfo(
int columnIndex
)
[CLSCompliantAttribute(false)]
public:
BufferColumn GetColumnInfo(
int columnIndex
)
[<CLSCompliantAttribute(false)>]
member GetColumnInfo :
columnIndex:int -> BufferColumn
public function GetColumnInfo(
columnIndex : int
) : BufferColumn
Parameters
- columnIndex
Type: System.Int32
The index of the column whose BufferColumn structure is retrieved.
Return Value
Type: Microsoft.SqlServer.Dts.Pipeline.BufferColumn
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.