coil::DynamicLib Class Reference

DynamicLib class. More...

#include <DynamicLib.h>

List of all members.

Public Member Functions
	DynamicLib (int close_handle_on_destruction=1)
	Constructor.
	DynamicLib (const char *dynlib_name, int open_mode=COIL_DEFAULT_DYNLIB_MODE, int close_handle_on_destruction=1)
	Constructor.
virtual	~DynamicLib ()
	Destructor.
	DynamicLib (const DynamicLib &rhs)
	Copy Constructor.
DynamicLib &	operator= (const DynamicLib &rhs)
	Assignment operator.
virtual int	open (const char *dll_name, int open_mode=COIL_DEFAULT_DYNLIB_MODE, int close_handle_on_destruction=1)
	Load of the Dynamic link library.
virtual int	close (void)
	Unload of the Dynamic link library.
void *	symbol (const char *symbol_name)
	Return an address of the memory where a symbol was loaded.
const char *	error (void) const
	Return the explanation message about the error.
Static Public Member Functions
static int	ForExternTest (void)
	Unit Test.

---

Detailed Description

DynamicLib class.

---

Constructor & Destructor Documentation

coil::DynamicLib::DynamicLib

(

int

close_handle_on_destruction = 1

)

Constructor.

Constructor

Parameters:

close_handle_on_destruction

Close flag.

coil::DynamicLib::DynamicLib	(	const char *	dynlib_name,
		int	open_mode = COIL_DEFAULT_DYNLIB_MODE,
		int	close_handle_on_destruction = 1
	)

Constructor.

Constructor

Parameters:

	dynlib_name	Dynamic link library name.
	open_mode	Open mode.
	close_handle_on_destruction	Close flag.

virtual coil::DynamicLib::~DynamicLib

(

)

[virtual]

Destructor.

Destructor

coil::DynamicLib::DynamicLib

(

const DynamicLib &

rhs

)

Copy Constructor.

Copy Constructor

Parameters:

rhs

Dynamic link library object of copy source.

---

Member Function Documentation

virtual int coil::DynamicLib::close

(

void

)

[virtual]

Unload of the Dynamic link library.

Unload of the Dynamic link library.

Returns:

0: successful, -1: failed

Referenced by RTC::ModuleManager::UnloadPred::operator()().

const char* coil::DynamicLib::error

(

void

)

const

Return the explanation message about the error.

Return the explanation message about the error.

Returns:

Error message.(NULL: not an error)

static int coil::DynamicLib::ForExternTest

(

void

)

[inline, static]

Unit Test.

Unit Test.

Returns:

0xdeadbeef

virtual int coil::DynamicLib::open	(	const char *	dll_name,
		int	open_mode = COIL_DEFAULT_DYNLIB_MODE,
		int	close_handle_on_destruction = 1
	)			[virtual]

Load of the Dynamic link library.

Load of the Dynamic link library.

Parameters:

	dll_name	Dynamic link library name.
	open_mode	Open mode.
	close_handle_on_destruction	Close flag.

Returns:

0: successful, -1: failed

DynamicLib& coil::DynamicLib::operator=

(

const DynamicLib &

rhs

)

Assignment operator.

Copy a Dynamic link library object.

Parameters:

rhs

Dynamic link library object of assignment source.

Returns:

Assignment result.

void* coil::DynamicLib::symbol

(

const char *

symbol_name

)

Return an address of the memory where a symbol was loaded.

Return an address of the memory where a symbol was loaded.

Parameters:

symbol_name

Symbol name.

Returns:

Memory address.(NULL: failed)