BBjRecoverFileStatus

Creation Path

BBjAPI > BBjFileSystem > BBjRecoverFileStatus

Description

In BBj 18.00 and higher, the BBjRecoverFileStatus object is used to return various status information from file recovery.

Creation

The BBjRecoverFileStatus object is created using the following BBjFileSystem method:

Return Value	Method
BBjRecoverFileStatus	recoverFile(string `filename`)
BBjRecoverFileStatus	recoverFile(string `filename`, string `modes`)
BBjRecoverFileStatus	recoverFile(string `filename`, string `modes`, string `tmpdir`)

Parameters

Variable	Description
filename	Specifies the name of the file to be recovered.
modes	Mode string to use for opening the original file and creating the new file. Notably, this is where "CRYPTPASS" could be specified for an encrypted file.
tmpdir	Temporary directory to use for the conversion temporary file. If not specified, it defaults to the same directory as the original file. Prior to 24.01, the default was the Java global temporary directory.

Methods of BBjRecoverFileStatus

Return Value	Method
long	getRecoverStartTimeMillis()
long	getRecoverFinishTimeMillis()
int	getOriginalFileType()
string	getOriginalFilename()
string	getRecoverBackupFilename()
int	getOriginalRecordSize()
long	getOriginalRecordCount()
long	getRecoveredRecordCount()
long	getRecordsFound()
long	getOriginalSize()
long	getRecoveredSize()

Remarks

None.

Constants

0x00	INDEXED_FILE
0x01	SERIAL_FILE
0x02	DIRECT_FILE
0x03	STRING_FILE
0x04	BBX_PROGRAM_FILE
0x84	BBJ_PROGRAM_FILE
0x05	DIRECTORY_FILE
0x06	MKEYED_FILE
0x80	MKEYED_4GIG
0x40	MKEYED_RECOVERABLE
0x20	MKEYED_64BIT
0x08	XKEYED_FILE
0x0B	JKEYED_FILE (Deprecated)
0x0D	VKEYED_FILE

Example

rem 'Obtain the instance of the BBjFileSystem object

BBjFileSystem! = BBjAPI().getFileSystem()

rem 'Recover a file
status! = BBjFileSystem!.recoverFile("recoverableFile.dat")

Version History

BBj 24.01: Added an optional tmpdir argument for BBjFileSystem::recoverFile.
BBj 24.00: Added an optional modes argument for BBjFileSystem::recoverFile.
BBj 18.00: BBjRecoverFileStatus added.