Murl::Resource::IArchive Interface Reference

The IArchive resource object interface. More...

#include "murl_resource_i_archive.h"

Inheritance diagram for Murl::Resource::IArchive:

Classes
struct	Iff
	IFF file specific structs. More...

Public Member Functions
virtual IObject *	GetObjectInterface ()=0
	Get the mutable Resource::IObject interface. More...
virtual const IObject *	GetObjectInterface () const =0
	Get the constant Resource::IObject interface. More...
virtual const ConstData &	GetData () const =0
	Get a data object containing the uncompressed data. More...
virtual Bool	ReleaseData () const =0
	Release the previously obtained data. More...

Detailed Description

The IArchive resource object interface.

An archive resource stores a (ZLib) compressed block of raw data, with optional encryption.

Member Function Documentation

GetObjectInterface() [1/2]

virtual IObject* Murl::Resource::IArchive::GetObjectInterface ( )

pure virtual

Get the mutable Resource::IObject interface.

Returns

The IObject interface.

GetObjectInterface() [2/2]

virtual const IObject* Murl::Resource::IArchive::GetObjectInterface ( ) const

pure virtual

Get the constant Resource::IObject interface.

Returns

The IObject interface.

GetData()

virtual const ConstData& Murl::Resource::IArchive::GetData ( ) const

pure virtual

Get a data object containing the uncompressed data.

Calling this method returns a constant data object containing the uncompressed payload data, performing decryption if necessary. If decryption or decompression fails, an empty data object is returned. It is necessary to make a corresponding call to ReleaseData() for every GetData() invocation.

Returns

A constant data object containing the uncompressed contents.

ReleaseData()

virtual Bool Murl::Resource::IArchive::ReleaseData ( ) const

pure virtual

Release the previously obtained data.

Returns

true if successful.

---

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

• murl_resource_i_archive.h