BBjFileSystem::recoverFile

Description

Rebuilds any recoverable file type based on the internal recovery information contained within the file. This includes MKEYED, XKEYED, and VKEYED file types.

Syntax

Return Value

Method

BBjRecoverFileStatus

recoverFile(string fileName)

Parameters

Variable

Description

fileName

Specifies the name of the file to be recovered.

Return Value

If the file recovery is successful, this returns a BBjRecoverFileStatus object with information about the file recovery.

Remarks

None.

Example

REM Recover an MKEYED/XKEYED file

REM Set the file name of the XKEYED file to be recovered
FILE_NAME$="C:\TEST\CUSTOMER.DAT"

REM Obtain the instance to the BBjAPI object
myAPI!=BBJAPI()

REM Obtain the instance to the BBjFileSystem object
myFileSystem!=myAPI!.getFileSystem()

REM Recover the XKEYED file
status!=myFileSystem!.recoverFile(FILE_NAME$)

See Also

BBjAPI

BBjRecoverFileStatus

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.