PipelineBuffer.GetBlobLength Method

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

returnValue = instance.GetBlobLength(columnIndex)
[CLSCompliantAttribute(false)]
public uint GetBlobLength(
    int columnIndex
)
[CLSCompliantAttribute(false)]
public:
unsigned int GetBlobLength(
    int columnIndex
)
[<CLSCompliantAttribute(false)>]
member GetBlobLength : 
        columnIndex:int -> uint32 
public function GetBlobLength(
    columnIndex : int
) : uint

Parameters

  • columnIndex
    Type: System.Int32
    The index of the column containing the BLOB.

Return Value

Type: System.UInt32
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.