GetByteChunk method

UltraLite ActiveX User's Guide
UltraLite ActiveX API Reference
ULColumn class

GetByteChunk method

Prototype

GetByteChunk (_
   offset As Long, _
   pByteArray, _
   [ chunkSize ] _
) As Long
Member of UltraliteActiveX.ULColumn

Description

Fills the buffer passed in, which should be an array, with the binary data in the column. Suitable for BLOBS.

Parameters

offset The offset into the underlying array of bytes. The source offset must be greater than or equal to 0, otherwise a ulSQLE_INVALID_PARAMETER error will be raised.

pByteArray A variant. Array data is passed by reference as array.

chunkSize An optional parameter representing an array of bytes expressed as Long type.

Returns

The number of bytes read.

Errors set

Error	Description
ulSQLE_CONVERSION_ERROR	The error occurs if the column data type isn't BINARY or LONG BINARY.
ulSQLE_INVALID_PARAMETER	The error occurs if the column data type is BINARY and the offset is not 0 or 1, or, the data length is less than 0. The error also occurs if the column data type is LONG BINARY and the offset is less than 1 or, the data length is less than 0.

Example

In the following example, edata is a column name.

' eMbedded Visual Basic
Dim data (512) As Byte
' ...
table.Columns.Item("edata").GetByteChunk(0,data)

// JScript
var data = new Array();
// ...
table.Columns.Item("edata").GetByteChunk(0, data);