SISFileRecord Class Reference

Information about a file component in a SIS file. More...

#include <sisfilerecord.h>

Public Member Functions
SisRC	fillFrom (uint8_t *buf, int *base, off_t len, SISFile *sisFile)
	Populate the fields. More...
uint8_t *	getDestPtr ()
uint8_t *	getFilePtr (int fileNo)
	Return a pointer to the file data for the file for the specified language. More...
void	setMainDrive (char drive)

Public Attributes
uint32_t	m_flags
	1 if multiple language versions, otherwise 0. More...
uint32_t	m_fileType
	Type of file. More...
uint32_t	m_fileDetails
	If file type is 1: More...
uint32_t	m_sourceLength
uint32_t	m_sourcePtr
uint32_t	m_destLength
uint32_t *	m_fileLengths

Private Attributes
uint32_t	m_destPtr
uint32_t *	m_filePtrs
uint8_t *	m_buf
	The buffer we belong to. More...
int	m_len

Detailed Description

Information about a file component in a SIS file.

The file can be for multiple languages, in which case a single instance holds pointers to contents for all languages.

Definition at line 33 of file sisfilerecord.h.

Member Function Documentation

fillFrom()

SisRC SISFileRecord::fillFrom	(	uint8_t *	buf,
		int *	base,
		off_t	len,
		SISFile *	sisFile
	)

Populate the fields.

Parameters

buf	The buffer to read from.
base	The index to start reading from, which is updated when the record is successfully read.
len	The length of the buffer.
sisFile	The container SISFile.

Definition at line 28 of file sisfilerecord.cpp.

getDestPtr()

uint8_t * SISFileRecord::getDestPtr ( )

inline

Definition at line 48 of file sisfilerecord.h.

getFilePtr()

uint8_t * SISFileRecord::getFilePtr

(

int

fileNo

)

Return a pointer to the file data for the file for the specified language.

Definition at line 129 of file sisfilerecord.cpp.

setMainDrive()

void SISFileRecord::setMainDrive

(

char

drive

)

Definition at line 139 of file sisfilerecord.cpp.

Member Data Documentation

m_buf

uint8_t* SISFileRecord::m_buf

private

The buffer we belong to.

Used for updating the destination file name.

Definition at line 107 of file sisfilerecord.h.

m_destLength

uint32_t SISFileRecord::m_destLength

Definition at line 95 of file sisfilerecord.h.

m_destPtr

uint32_t SISFileRecord::m_destPtr

private

Definition at line 100 of file sisfilerecord.h.

m_fileDetails

uint32_t SISFileRecord::m_fileDetails

If file type is 1:

• 0. Continue.
• 1. Yes, No (skip next file).
• 2. Yes, No (abort installation).

If file type is 3:

• 0. Run during installation.
• 1. Run during removal.
• 2. Run during both installation and removal.

Definition at line 91 of file sisfilerecord.h.

m_fileLengths

uint32_t* SISFileRecord::m_fileLengths

Definition at line 96 of file sisfilerecord.h.

m_filePtrs

uint32_t* SISFileRecord::m_filePtrs

private

Definition at line 101 of file sisfilerecord.h.

m_fileType

uint32_t SISFileRecord::m_fileType

Type of file.

• 0. Standard file.
• 1. Text file to display during installation.
• 2. SIS component.
• 3. File to run during installation/removal.
• 4. Does not exist yet, but will be created when app is run, so it should not be removed during an upgrade.

Definition at line 76 of file sisfilerecord.h.

m_flags

uint32_t SISFileRecord::m_flags

1 if multiple language versions, otherwise 0.

Definition at line 64 of file sisfilerecord.h.

m_len

int SISFileRecord::m_len

private

Definition at line 109 of file sisfilerecord.h.

m_sourceLength

uint32_t SISFileRecord::m_sourceLength

Definition at line 93 of file sisfilerecord.h.

m_sourcePtr

uint32_t SISFileRecord::m_sourcePtr

Definition at line 94 of file sisfilerecord.h.

---

The documentation for this class was generated from the following files:

• lib/sisfilerecord.h
• lib/sisfilerecord.cpp