Skip Headers

Oracle® Objects for OLE Developer's Guide
10g Release 1 (10.1)

Part Number B10118-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Feedback

Read (OraLOB/BFILE) Method

Applies To

OraBLOB, OraCLOB

OraBFILE

Description

Reads into a buffer a specified portion of BLOB, CLOB, or BFILE value. Returns the total amount of data read.

Arguments
Description
[out] buffer
Variant of type character array for OraClob or Variant of type byte array for OraBlob or OraBFILE from which the piece will be read.
[in][optional] chunksize
An Integer specifying amount to be read. Default value is the size of the LOB. In bytes for OraBlob/OraBFile, characters for OraClob.
[out] amount_read
An integer representing the total amount of data read. In bytes for OraBlob/OraBFile, characters for OraClob.
Usage

amount_read = OraBlob.Read buffer,chunksize

amount_read = OraClob.Read buffer,chunksize

amount_read = OraBfile.Read buffer,chunksize

Remarks

Reads the LOB or BFILE data from the offset specified by the Offset property. For multiple piece read operation, the PollingAmount property must be set to the value of total amount of data to be read and the Status property must be checked for the success of each piece operation.

Note: When reading a portion of a LOB, it is recommended that you set the PollingAmount property rather than using the chunksize parameter. This avoids the possibility of a raising error if the entire LOB is not read prior to executing another LOB method.

Examples

Example: Multiple piece-wise Read of a LOB

Example: Single piece Read of a LOB