cee::ug::VTFxFileBrowser

class VTFxFileBrowser

Helper class that allows you to read case metadata from a VTFx file.

Use the VTFx file browser to get information about an existing VTFx file.

Available metadata:

  • Case count

  • Case names

  • Case descriptions

  • Case snapshot images

  • User files

The VTFxFileBrowser can also check if an existing VTFx file is valid (isVTFxFile()).

Public Functions

VTFxFileBrowser()

Constructs an empty object.

bool initialize(const Str &fileName)

Opens a VTFx file in read only mode.

File must be opened before any case info can be retrieved.

Returns true if file was opened successfully.

bool initialize(const VTFxMemoryFile *vtfxMemFile)

Opens a VTFx file in read only mode.

File must be opened before any case info can be retrieved.

Returns true if file was opened successfully.

void setPassword(const Str &password)

Sets the password used to decrypted encrypted files.

If file is encrypted, the password must be set before calling initialize()

size_t caseCount() const

Returns number of cases in the file.

Str caseName(size_t caseIndex) const

Returns the case name for the case with the given index.

Str caseDescriptionHtml(size_t caseIndex) const

Returns the case description for the case with the given index.

Image *caseSnapshot(size_t caseIndex) const

Returns the case snapshot for the case with the given index. Returns NULL if no snapshot image.

int caseId(size_t caseIndex) const

Returns the case name for the case with the given index.

size_t caseIndex(int caseId) const

Returns the case name for the case with the given index.

Str readTextFile(const Str &filename) const

Returns the content of a text file within the VTFx archive as a string.

The filename is the full path within the VTFx archive, including file ending. For instance, UserData/myConfig.xml.

size_t userTextFileCount() const

Returns the number of user created text files in the VTFx file.

Str userTextFileName(size_t userTextFileIndex) const

Returns the name of the user text file with index textFileIndex.

Str userTextFileContent(size_t userTextFileIndex) const

Returns the content of the user text file with index textFileIndex.

int vendorId() const

Returns the vendor id of the current VTFx model.

bool hasValidExpressSignature(const Str &vendorCode) const

Returns true if the current VTFx file has a valid express signature.

bool isPasswordValid() const

Returns true if the password that has been set for the browser allows to open the file.

bool isLegacyFile() const

Returns true if the file is a legacy (Gen2) file with old-style properties.

bool fileInfo(PropertySet *properties)

Gets the file information for this file.

Gets file information such as export date, vendor name, vendor application and database name to the given property set. Returns true if any properties were found.

Public Static Functions

static bool isVTFxFile(const Str &fileName)

Returns true if file fileName is a valid VTFx file.

static bool isEncrypted(const Str &fileName)

Returns true if file fileName is encrypted and requires a password to be opened.