FileHeader

Fields

const unsigned int

_signature

Functions

	SET_CID
	SET_CHUNK_SIGNATURE
	FileHeader
	FileHeader
	~FileHeader
const String &	GetParentApplication
const String &	GetAuthorName
bool	IsEncrypted
Version	GetRedsdkVersion

Detailed Description

class FileHeader : public RED::Object

This class stores the info read from a .red file header.

@related The .red File Format, class RED::IREDFile

After a successful reading of a .red file, you’ll get access to its file header. It encodes some global information about the read file including:

• the parent application (optional),

• the version of Luminate used to write the file,

• the name of the file author (optional),

• the encryption status of the file.

Public Functions

SET_CID (CID_class_REDFileHeader) IMPLEMENT_AS()

SET_CHUNK_SIGNATURE (0x00000001)

FileHeader()

FileHeader default construction method.

FileHeader(const RED::String &iParentApplication, const RED::String &iAuthor, const RED::Version &iVersion, bool iEncrypted)

Construction method.

Parameters

• iParentApplication – Name of the application source of the file.

• iAuthor – File author’s name.

• iVersion – REDsdk version used to create the file.

• iEncrypted – Is the file encrypted or not ?

~FileHeader()

FileHeader destruction method.

inline const RED::String &GetParentApplication() const

Gets the parent application name.

Returns

A string describing the parent application that produced the .red file.

inline const RED::String &GetAuthorName() const

Returns

A string describing the author of the .red file.

inline bool IsEncrypted() const

Returns

A boolean value describing whether the .red file is encrypted (true) or not (false).

inline Version GetRedsdkVersion() const

Returns

The REDsdk version that was used to build the .red file.

Public Static Attributes

static const unsigned int _signature

Chunk’s signature.