MyGUI::DynLib Class Reference

Resource holding data about a dynamic library. More...

#include <MyGUI_DynLib.h>

Public Member Functions
bool	load ()
void	unload ()
std::string	getName (void) const
	Get the name of the library.
void *	getSymbol (const std::string &strName) const throw ()
Protected Member Functions
	DynLib (const std::string &name)
	~DynLib ()
std::string	dynlibError (void)
	Gets the last loading error.
Protected Attributes
std::string	mName
	Name of library.
MYGUI_DYNLIB_HANDLE	mInstance
	Handle to the loaded library.
Friends
class	DynLibManager

---

Detailed Description

Resource holding data about a dynamic library.

Remarks:

This class holds the data required to get symbols from libraries loaded at run-time (i.e. from DLL's for so's)

Definition at line 64 of file MyGUI_DynLib.h.

---

Constructor & Destructor Documentation

MyGUI::DynLib::DynLib

(

const std::string &

name

)

[protected]

Definition at line 35 of file MyGUI_DynLib.cpp.

MyGUI::DynLib::~DynLib

(

)

[protected]

Definition at line 42 of file MyGUI_DynLib.cpp.

---

Member Function Documentation

std::string MyGUI::DynLib::dynlibError

(

void

)

[protected]

Gets the last loading error.

Definition at line 86 of file MyGUI_DynLib.cpp.

std::string MyGUI::DynLib::getName

(

void

)

const [inline]

Get the name of the library.

Definition at line 84 of file MyGUI_DynLib.h.

void * MyGUI::DynLib::getSymbol

(

const std::string &

strName

)

const throw ()

Returns the address of the given symbol from the loaded library.

Parameters:

strName

The name of the symbol to search for

Returns:

If the function succeeds, the returned value is a handle to the symbol. If the function fails, the returned value is nullptr.

Definition at line 76 of file MyGUI_DynLib.cpp.

bool MyGUI::DynLib::load

(

)

Load the library

Definition at line 47 of file MyGUI_DynLib.cpp.

void MyGUI::DynLib::unload

(

)

Unload the library

Definition at line 62 of file MyGUI_DynLib.cpp.

---

Friends And Related Function Documentation

friend class DynLibManager [friend]

Definition at line 66 of file MyGUI_DynLib.h.

---

Field Documentation

MYGUI_DYNLIB_HANDLE MyGUI::DynLib::mInstance [protected]

Handle to the loaded library.

Definition at line 106 of file MyGUI_DynLib.h.

std::string MyGUI::DynLib::mName [protected]

Name of library.

Definition at line 103 of file MyGUI_DynLib.h.

---

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

• MyGUI_DynLib.h
• MyGUI_DynLib.cpp