PWToolBox::SharedLibrary Class Reference

Represents a shared library on the system. The implementation of this class is dependant on the underlying operating system. More...

#include <SharedLibrary.h>

List of all members.

Public Types
typedef void *	SymbolType
	The type of the symbol in the shared library when using Windows.
typedef void *(*)	SymbolType ()
	The type of the symbol in the shared library when using Linux.
typedef HINSTANCE	HandleType
	The type of the handle to the shared library when using Windows.
typedef void *	HandleType
	The type of the handle to the shared library when using Linux.
Public Member Functions
SymbolType	findSymbol (std::string const &symbol)
	Finds the symbol in the library.
	SharedLibrary (boost::filesystem::path const &path)
	Creates a new shared library from the specified path.
	~SharedLibrary ()
boost::filesystem::path const &	getPath () const
	Retrieves the system path of the SharedLibrary.

---

Detailed Description

Represents a shared library on the system. The implementation of this class is dependant on the underlying operating system.

---

Member Typedef Documentation

typedef void* PWToolBox::SharedLibrary::SymbolType

The type of the symbol in the shared library when using Windows.

typedef void*(*) PWToolBox::SharedLibrary::SymbolType()

The type of the symbol in the shared library when using Linux.

typedef HINSTANCE PWToolBox::SharedLibrary::HandleType

The type of the handle to the shared library when using Windows.

typedef void* PWToolBox::SharedLibrary::HandleType

The type of the handle to the shared library when using Linux.

---

Constructor & Destructor Documentation

PWToolBox::SharedLibrary::SharedLibrary

(

boost::filesystem::path const &

path

)

Creates a new shared library from the specified path.

Parameters:

path

The path of the shared library

Exceptions:

InvalidArgumentException

Thrown when path does not exist

PWToolBox::SharedLibrary::~SharedLibrary

(

)

---

Member Function Documentation

SymbolType PWToolBox::SharedLibrary::findSymbol

(

std::string const &

symbol

)

Finds the symbol in the library.

Parameters:

symbol

The symbol to load from the library.

Returns:

The symbol loaded from the library.

Exceptions:

SharedLibraryException

Thrown when the symbol wasn't found.

boost::filesystem::path const& PWToolBox::SharedLibrary::getPath

(

)

const [inline]

Retrieves the system path of the SharedLibrary.

Returns:

The system path to the SharedLibrary

---

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

• SharedLibrary.h

---