PipelineBuffer.GetColumnInfo Method

Article
12/03/2008

Retrieves the BufferColumn structure for a PipelineBuffer column. This method 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

[CLSCompliantAttribute(false)] 
public BufferColumn GetColumnInfo (
    int columnIndex
)

[CLSCompliantAttribute(false)] 
public:
BufferColumn GetColumnInfo (
    int columnIndex
)

/** @attribute CLSCompliantAttribute(false) */ 
public BufferColumn GetColumnInfo (
    int columnIndex
)

CLSCompliantAttribute(false) 
public function GetColumnInfo (
    columnIndex : int
) : BufferColumn

Parameters

columnIndex
The index of the column whose BufferColumn structure is retrieved.

Return Value

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.

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