pstsdk::file Class Reference

A generic class to read and write to a file. More...

#include <util.h>

Inheritance diagram for pstsdk::file:

Collaboration diagram for pstsdk::file:

Public Member Functions
	file ()
	file (const std::wstring &filename, bool writable=false)
	Construct a file object from the given filename.
	~file ()
	Close the file.
virtual size_t	read (std::vector< byte > &buffer, ulonglong offset) const
	Read from the file.

Detailed Description

A generic class to read and write to a file.

This was necessary to get around the 32 bit limit (4GB) file size limitation in ANSI C++. I needed to use compiler specific work arounds, and that logic is centralized here.

Definition at line 44 of file util.h.

Constructor & Destructor Documentation

file() [1/2]

pstsdk::file::file ( )

inline

Definition at line 48 of file util.h.

file() [2/2]

pstsdk::file::file ( const std::wstring &  filename, bool  writable = false  )

inline

Construct a file object from the given filename.

Exceptions

runtime_error

if an error occurs opening the file

Parameters

[in]	filename	The file to open
[in]	writable	Open for update, so write can be used

Definition at line 152 of file util.h.

~file()

pstsdk::file::~file ( )

inline

Close the file.

Definition at line 170 of file util.h.

Member Function Documentation

read()

size_t pstsdk::file::read ( std::vector< byte > &  buffer, ulonglong  offset  ) const

inlinevirtual

Read from the file.

Exceptions

out_of_range

if the requested location or location+size is past EOF

Parameters

[in,out]	buffer	The buffer to store the data in. The size of this vector is the amount of data to read.
[in]	offset	The location on disk to read the data from.

Returns

The amount of data read

Definition at line 177 of file util.h.

---

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

• pstsdk/util/util.h