CopyToFile (OraLOB/BFILE) Method

Applies To

Description

Copies a portion or all of the internal LOB value of this object to the local file.

Usage

OraBlob.CopyToFile "blob.bmp" amount,offset,chunksize
OraClob.CopyToFile "clob.txt" amount,offset,chunksize
OraBfile.CopyToFile "bfile.bmp" amount,offset,chunksize

Arguments

The arguments for the method are:

Arguments	Description
[`in`] `filename`	A `String` specifying the absolute name and path for which the file is to be written.
[`in`] [optional] `amount`	An `Integer` specifying the maximum amount to be copied, in bytes for `OraBLOB`/`OraBFILE` and characters for `OraCLOB`. Default value is the size of the LOB or `BFILE`.
[`in`] [optional] `offset`	An `Integer` specifying absolute offset of the LOB or `BFILE` value of this instance, in bytes for `OraBLOB`/`OraBFILE` and characters for `OraCLOB`. Default value is `1`.
[`in`] [optional] `chunksize`	An `Integer` specifying the size, in bytes, for each write operation. If the `chunksize` parameter is not set or is `0`, the value of the `amount` argument is used which means the entire amount is transferred in one chunk.

Remarks

The file is in the same format as the NLS_LANG setting.

If the file exists, its contents is overwritten.

Examples

Example:Using the CopyToFile Method

This example demonstrates the use of the CopyToFile method.

Be sure that you have the PART table in the database with valid LOB data in it. Also, be sure that you have installed the OraLOB Schema Objects as described in "Schema Objects Used in LOB Data Type Examples" .

Dim OraSession As OraSession 
Dim OraDatabase As OraDatabase 
Dim PartDesc as OraCLOB 
 
'Create the OraSession Object. 
Set OraSession = CreateObject("OracleInProcServer.XOraSession") 
 
'Create the OraDatabase Object by opening a connection to Oracle. 
Set OraDatabase = OraSession.OpenDatabase("ExampleDb", "scott/tiger", 0&
 
'Create a Dynaset containing a BLOB and a CLOB column 
set part = OraDatabase.CreateDynaset ("select * from part where" & _
                "part_id = 1234",0) 
set PartDesc = part.Fields("part_desc").Value 
 
'Copy the entire LOB content to partdesc.txt file 
PartDesc.CopyToFile "partdesc.txt"