Clay Library  1.0.1
All Classes Functions Variables Groups
Public Member Functions | List of all members
clay::plugin::ClayModule Class Reference

Plugin Module Class. More...

#include <clay_plugin.h>

Public Member Functions

 ClayModule (const std::string &sName)
 
virtual ~ClayModule ()
 Destructor function.
 
std::string GetName ()
 
void * GetHandle ()
 
void * Load (const std::string &sLibraryFileName)
 
void Unload ()
 Unload the module.
 
bool IsLoaded ()
 
void * GetFunction (const std::string &sFunctionName)
 

Detailed Description

Plugin Module Class.

Constructor & Destructor Documentation

clay::plugin::ClayModule::ClayModule ( const std::string &  sName)
explicit

Constructor function

Parameters
sNameThe module name

Member Function Documentation

void* clay::plugin::ClayModule::GetFunction ( const std::string &  sFunctionName)

Get the function pointer by its name

Parameters
sFunctionNameThe function name
Returns
The function pointer
void* clay::plugin::ClayModule::GetHandle ( )

Get module handle

Returns
The module handle
std::string clay::plugin::ClayModule::GetName ( )

Get module name

Returns
The module name
bool clay::plugin::ClayModule::IsLoaded ( )

Check whether the module has been loaded

Returns
Return true if the module has been loaded
void* clay::plugin::ClayModule::Load ( const std::string &  sLibraryFileName)

Load the DLL file by its full path name

Parameters
sLibraryFileNameThe full path name of the DLL file
Returns
If fail then return NULL else return the handle of the module

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