PipelineBuffer.GetBlobLength Method

Article
12/03/2008

Gets the number of bytes contained in a binary large object (BLOB) 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 GetBlobLength ( _
    columnIndex As Integer _
) As UInteger

[CLSCompliantAttribute(false)] 
public uint GetBlobLength (
    int columnIndex
)

[CLSCompliantAttribute(false)] 
public:
unsigned int GetBlobLength (
    int columnIndex
)

/** @attribute CLSCompliantAttribute(false) */ 
public UInt32 GetBlobLength (
    int columnIndex
)

CLSCompliantAttribute(false) 
public function GetBlobLength (
    columnIndex : int
) : uint

Parameters

columnIndex
The index of the column containing the BLOB.

Return Value

The number of bytes in the binary large object.

Remarks

The GetBlobLength method is used to determine the number of bytes contained in a PipelineBuffer column containing a BLOB data type, such as a DT_IMAGE. This method is typically called prior to a call to the GetBlobData method. The third parameter to GetBlobData is the number of bytes to retrieve from the BLOB. You call GetBlobLength prior to GetBlobData when you want to retrieve all the bytes in a BLOB PipelineBuffer column.

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