DbiGetBlobSize

C syntax

DBIResult DBIFN DbiGetBlobSize (hCursor, pRecBuf, iField, piSize);

Delphi syntax

function DbiGetBlobSize (hCursor: hDBICur; pRecBuf: Pointer; iField: Word; var iSize: Longint): DBIResult stdcall;

Description

DbiGetBlobSize retrieves the size of the specified BLOB field in bytes.

Parameters

hCursor Type: hDBICur (Input)
Specifies the cursor handle.

pRecBuf Type: pBYTE (Input)
Pointer to the record buffer containing the BLOB handle. The client application must first allocate the buffer and fetch a valid record. A call to DbiOpenBlob then obtains the BLOB handle.

iField Type: UINT16 (Input)
Specifies the ordinal number of the BLOB field within the specified record buffer.

piSize Type: pUINT32 (Output)
Pointer to the client variable that receives the BLOB size in bytes.

Usage

This function is used to get the size of a BLOB.

Prerequisites

The current record buffer must contain a BLOB field which has been opened by a call to DbiOpenBlob.

Completion state

piSize points to the retrieved size of the BLOB field.

DbiResult	Meaning
DBIERR_NONE	The BLOB size was successfully retrieved.
DBIERR_BLOBNOTOPENED	The specified BLOB field has not been opened with a call to DbiOpenBlob.
DBIERR_INVALIDBLOBHANDLE	The logical BLOB handle supplied in the record buffer is invalid.
DBIERR_NOTABLOB	The specified field number does not correspond to a BLOB field.