DbLobReadToFile

Note: This page includes content based on the F1 documentation for Centura development. It may be partially converted to support APF development, but should be regarded to be of uncertain actuality. It is provided as is. Eventually, it should be replaced by documentation available from within Visual Studio.

public SalBoolean DbLobReadToFile(SalSqlHandle hSql, SalString sColumnName, SalString sView, SalString sObjid, SalString sFileName, ref SalNumber nFileErrorCode)

The DbLobReadToFile method reads (streams) a CLOB/BLOB object, defined in a view, to a predefined file.

Parameters

Name Description
hSql Handle that identifies the database connection
sColumnName Name of the SQL column that is the LOB object.
sView View where the LOB column is located.
sObjid OBJID to the record the LOB should be read from.
sFileName The file name the LOB should be written to.
nFileErrorCode If an error was caused by the file I/O operation, the value is a VTERR_* error code.
If the operation completed successfully, the value is VTERR_Ok.

Returns

TRUE if the operation succeeded, FALSE otherwise.

Comments

The PL/SQL method must have a certain list of arguments in order to work with the DbLobReadToFile method. Details and examples can be found in the Large Objects section in Development Guide for IFS/Base Server.

Example

sObjversion = DataRecordVersionGet( ) 
bOK = DbLobReadToFile( c_hSql, 'TEXT', 'LOB', DataRecordIdGet( ), sFileName, nFileErrorCode )