eLynx::PluginFile Class Reference

#include <PluginFile.h>

List of all members.

Public Member Functions
	PluginFile ()
	default constructor, constructs a invalid handle.
	PluginFile (const char *iprFilename)
	constructs from filename.
	~PluginFile ()
	unloads the library if this is the last PluginFile to the loaded library.
bool	Load (const char *iprFilename)
	loads the library.
void	Unload ()
	unloads the library and sets invalid.
bool	IsValid () const
	returns true if the PluginFile is valid, false otherwise.
const char *	GetFilename () const
	get the loaded module filename.
const IPluginPackage *	GetPackage () const
	return the reference on IPluginPackage of the PluginFile
Protected Attributes
const IPluginPackage *	_prPackage
ModuleId	_ModuleId
char	_Filename [elxPATH_MAX]

---

Detailed Description

PluginFile is a handle to a IPluginPackage. Simplifies the task of loading and unloading plugin libraries. A IPluginPackage PluginFile MUST remain in existence as long as any plugins created by it exist.

Definition at line 36 of file PluginFile.h.

---

Constructor & Destructor Documentation

eLynx::PluginFile::PluginFile

(

)

default constructor, constructs a invalid handle.

eLynx::PluginFile::PluginFile

(

const char *

iprFilename

)

constructs from filename.

eLynx::PluginFile::~PluginFile

(

)

unloads the library if this is the last PluginFile to the loaded library.

---

Member Function Documentation

bool eLynx::PluginFile::Load

(

const char *

iprFilename

)

loads the library.

void eLynx::PluginFile::Unload

(

)

unloads the library and sets invalid.

bool eLynx::PluginFile::IsValid

(

)

const

returns true if the PluginFile is valid, false otherwise.

const char* eLynx::PluginFile::GetFilename

(

)

const

get the loaded module filename.

const IPluginPackage* eLynx::PluginFile::GetPackage

(

)

const

return the reference on IPluginPackage of the PluginFile

---

Member Data Documentation

const IPluginPackage* eLynx::PluginFile::_prPackage [protected]

Definition at line 64 of file PluginFile.h.

ModuleId eLynx::PluginFile::_ModuleId [protected]

Definition at line 65 of file PluginFile.h.

char eLynx::PluginFile::_Filename[elxPATH_MAX] [protected]

Definition at line 66 of file PluginFile.h.

---

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

• PluginFile.h