PDynaLink Class Reference

#include <dynalink.h>

Inheritance diagram for PDynaLink:

List of all members.

DLL entry point functions
typedef void(*)	Function ()
	Primitive pointer to a function for a dynamic link module.
BOOL	GetFunction (PINDEX index, Function &func)
BOOL	GetFunction (const PString &name, Function &func)
Load/Unload function
virtual BOOL	Open (const PString &name)
virtual void	Close ()
virtual BOOL	IsLoaded () const
virtual PString	GetName (BOOL full=FALSE) const
static PString	GetExtension ()
Protected Attributes
void *	dllHandle
PString	name

---

Detailed Description

A dynamic link library. This allows the loading at run time of code modules for use by an application. MacOS X/darwin supports plugins linked as object file image (linked with the -bundle arg to ld) or dynamic libraries (-dynamic). On all Unix platforms the file name should end in ".so". On Windows the filename should end in ".dll"

---

Member Typedef Documentation

typedef void(*) PDynaLink::Function()

Primitive pointer to a function for a dynamic link module.

---

Constructor & Destructor Documentation

PDynaLink::PDynaLink

(

)

Create a new dyna-link, loading the specified module. The first, parameterless, form does load a library.

PDynaLink::PDynaLink

(

const PString &

name

)

Create a new dyna-link, loading the specified module. The first, parameterless, form does load a library.

Parameters:

name	Name of the dynamically loadable module.

PDynaLink::~PDynaLink

(

)

Destroy the dyna-link, freeing the module.

PDynaLink::PDynaLink

(

)

Create a new dyna-link, loading the specified module. The first, parameterless, form does load a library.

PDynaLink::PDynaLink

(

const PString &

name

)

Create a new dyna-link, loading the specified module. The first, parameterless, form does load a library.

Parameters:

name	Name of the dynamically loadable module.

PDynaLink::~PDynaLink

(

)

Destroy the dyna-link, freeing the module.

---

Member Function Documentation

virtual BOOL PDynaLink::Open

(

const PString &

name

)

[virtual]

Parameters:

name	Name of the dynamically loadable module.

virtual void PDynaLink::Close

(

)

[virtual]

Close the dyna-link library.

virtual BOOL PDynaLink::IsLoaded

(

)

const [virtual]

Dyna-link module is loaded and may be accessed.

virtual PString PDynaLink::GetName

(

BOOL

full = FALSE

)

const [virtual]

Get the name of the loaded library. If the library is not loaded this may return an empty string.

If full# is TRUE then the full pathname of the library is returned otherwise only the name part is returned.

Returns:

String for the library name.

Parameters:

full	Flag for full or short path name

static PString PDynaLink::GetExtension

(

)

[static]

Get the extension used by this platform for dynamic link libraries.

Returns:

String for file extension.

BOOL PDynaLink::GetFunction	(	PINDEX	index,
		Function &	func
	)

Get a pointer to the function in the dynamically loadable module.

Returns:

TRUE if function was found.

Parameters:

index	Ordinal number of the function to get.
func	Refrence to point to function to get.

BOOL PDynaLink::GetFunction	(	const PString &	name,
		Function &	func
	)

Get a pointer to the function in the dynamically loadable module.

Returns:

TRUE if function was found.

Parameters:

name	Name of the function to get.
func	Refrence to point to function to get.

---

Member Data Documentation

void* PDynaLink::dllHandle [protected]

PString PDynaLink::name [protected]

---

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

• dynalink.h

---