PipelineBuffer.GetBlobData(Int32, Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline

Assembly:: Microsoft.SqlServer.PipelineHost.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves an array of bytes from a binary large object (BLOB) stored in a PipelineBuffer column.

public:
 cli::array <System::Byte> ^ GetBlobData(int columnIndex, int offset, int count);

public byte[] GetBlobData (int columnIndex, int offset, int count);

member this.GetBlobData : int * int * int -> byte[]

Public Function GetBlobData (columnIndex As Integer, offset As Integer, count As Integer) As Byte()

Parameters

columnIndex: Int32

The index of the column containing the BLOB.

offset: Int32

The point in the BLOB to begin retrieving bytes from the BLOB.

count: Int32

The number of bytes to retrieve from the BLOB.

Returns

Byte[]

The array of bytes in the PipelineBuffer column.

Examples

The following example retrieves the entire array of bytes from a PipelineBuffer column.

public override void ProcessInput(int inputID, PipelineBuffer buffer)  
{  
   IDTSInput100 input = ComponentMetaData.InputCollection.GetObjectByID(inputID);  

   foreach (IDTSInputColumn100 col in input.InputColumnCollection)  
   {  
      int index = BufferManager.FindColumnByLineageID(input.Buffer, col.LineageID);  
      BufferColumn bc = buffer.GetColumnInfo(index);  

      if (bc.DataType == DataType.DT_IMAGE)  
      {  
         uint blobLength =  buffer.GetBlobLength(index);  
         byte [] blobBytes = buffer.GetBlobData(index, 0, (int)blobLength);  

         //TODO: Do something with the blob data.  

      }  
   }  
}

Public  Overrides Sub ProcessInput(ByVal inputID As Integer, ByVal buffer As PipelineBuffer)   
 Dim input As IDTSInput100 = ComponentMetaData.InputCollection.GetObjectByID(inputID)   
 For Each col As IDTSInputColumn100 In input.InputColumnCollection   
   Dim index As Integer = BufferManager.FindColumnByLineageID(input.Buffer, col.LineageID)   
   Dim bc As BufferColumn = buffer.GetColumnInfo(index)   
   If bc.DataType = DataType.DT_IMAGE Then   
     Dim blobLength As System.UInt32 = buffer.GetBlobLength(index)   
     Dim blobBytes As Byte() = buffer.GetBlobData(index, 0, CType(blobLength, Integer))   
     'TODO: Do something with the blob data  
   End If   
 Next   
End Sub

Remarks

This method works with the following Integration Services data types:

When retrieving data from PipelineBuffer columns containing a BLOB, such as a DT_IMAGE, you specify the starting location in the BLOB with the offset parameter and the number of bytes to retrieve in the count parameter.

For a complete list of Integration Services data types and the corresponding Get and Set methods of the PipelineBuffer class to use with each type, see Working with Data Types in the Data Flow.

Applies to

Share via