C

QSafeFile Class

class SafeRenderer::QSafeFile

The QSafeFile class reads the data from the file. More...

Header:	#include <QSafeFile>
Since:	QtSafeRenderer 1.0

List of all members, including inherited members

Public Functions

	QSafeFile(const SafeRenderer::qchar const filenameArg, const SafeRenderer::FileOpenMode modeArg* = FileOpenMode::ReadOnly)
	~QSafeFile()
SafeRenderer::quint32	available() const
void	readData(SafeRenderer::quchar const bufferArg, const SafeRenderer::quint32 bytes, const off_t offset* = 0) const

Detailed Description

The QSafeFile uses the Posix API for file access.

Member Function Documentation

`[explicit]` QSafeFile::QSafeFile(const SafeRenderer::qchar const filenameArg, const SafeRenderer::FileOpenMode modeArg* = FileOpenMode::ReadOnly)

Constructs the safe file object.

Opens the file named filenameArg with the open mode specified by modeArg.

modeArg is an optional parameter, with the default value being QSafeFile::OpenMode::ReadOnly. For possible open modes see QSafeFile::OpenMode.

In case of a failure, the following exception will be thrown:

Exception	Id	Description
SafeRenderer::QSafeFileException	SafeRenderer::QSafeFileException::FileException::FailureToOpen	The file could not be opened for reading.

QSafeFile::~QSafeFile()

Destructs a safe file object.

Closes the file if the file is open.

SafeRenderer::quint32 QSafeFile::available() const

Returns the amount of bytes is available in the file. 0 in case of any failure.

void QSafeFile::readData(SafeRenderer::quchar const bufferArg, const SafeRenderer::quint32 bytes, const off_t offset* = 0) const

Reads bytes amount of data from the opened file to the bufferArg.

The optional offset parameter specifies the starting point for file reading in bytes from the start of the file. Provide a non-negative integer; if offset exceeds file size, it triggers SafeRenderer::QSafeFile::OutOfBoundsError. If offset is 0 (default) reading starts from the file's beginning.