coil::DynamicLib Class Reference

DynamicLib class. More...

#include <DynamicLib.h>

List of all members.

Public Member Functions
virtual int	close (void)
	Unload of the Dynamic link library.
virtual int	close (void)
	Unload of the Dynamic link library.
	DynamicLib (int close_handle_on_destruction=1)
	Constructor.
	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.
	DynamicLib (const char *dynlib_name, int open_mode=COIL_DEFAULT_DYNLIB_MODE, int close_handle_on_destruction=1)
	Constructor.
	DynamicLib (const DynamicLib &rhs)
	Copy Constructor.
	DynamicLib (const DynamicLib &rhs)
	Copy Constructor.
const char *	error (void) const
	Return the explanation message about the error.
const char *	error (void) const
	Return the explanation message about the error.
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	open (const char *dll_name, int open_mode=COIL_DEFAULT_DYNLIB_MODE, int close_handle_on_destruction=1)
	Load of the Dynamic link library.
DynamicLib &	operator= (const DynamicLib &rhs)
	Assignment operator.
DynamicLib &	operator= (const DynamicLib &rhs)
	Assignment operator.
void *	symbol (const char *symbol_name)
	Return an address of the memory where a symbol was loaded.
void *	symbol (const char *symbol_name)
	Return an address of the memory where a symbol was loaded.
virtual	~DynamicLib ()
	Destructor.
virtual	~DynamicLib ()
	Destructor.
Static Public Member Functions
static int	ForExternTest (void)
	Unit Test.
static int	ForExternTest (void)
	Unit Test.
Private Attributes
int	m_closeflag
int	m_error
void *	m_handle
HINSTANCE	m_handle
int	m_mode
std::string	m_name

---

Detailed Description

DynamicLib class.

Definition at line 48 of file posix/coil/DynamicLib.h.

---

Constructor & Destructor Documentation

coil::DynamicLib::DynamicLib

(

int

close_handle_on_destruction = 1

)

Constructor.

Constructor

Parameters:

close_handle_on_destruction

Close flag.

Definition at line 30 of file posix/coil/DynamicLib.cpp.

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.

Definition at line 42 of file posix/coil/DynamicLib.cpp.

coil::DynamicLib::~DynamicLib

(

)

[virtual]

Destructor.

Destructor

Definition at line 61 of file posix/coil/DynamicLib.cpp.

coil::DynamicLib::DynamicLib

(

const DynamicLib &

rhs

)

Copy Constructor.

Copy Constructor

Parameters:

rhs	Dynamic link library object of copy source.

Definition at line 73 of file posix/coil/DynamicLib.cpp.

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

int coil::DynamicLib::close

(

void

)

[virtual]

Unload of the Dynamic link library.

Unload of the Dynamic link library.

Returns:

0: successful, -1: failed

Definition at line 127 of file posix/coil/DynamicLib.cpp.

virtual int coil::DynamicLib::close

(

void

)

[virtual]

Unload of the Dynamic link library.

Unload of the Dynamic link library.

Returns:

0: successful, -1: failed

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)

Definition at line 161 of file posix/coil/DynamicLib.cpp.

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

Definition at line 280 of file posix/coil/DynamicLib.h.

static int coil::DynamicLib::ForExternTest

(

void

)

[inline, static]

Unit Test.

Unit Test.

Returns:

0xdeadbeef

Definition at line 291 of file win32/coil/DynamicLib.h.

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

Definition at line 106 of file posix/coil/DynamicLib.cpp.

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.

Definition at line 89 of file posix/coil/DynamicLib.cpp.

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)

Definition at line 148 of file posix/coil/DynamicLib.cpp.

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)

---

Member Data Documentation

int coil::DynamicLib::m_closeflag [private]

Definition at line 285 of file posix/coil/DynamicLib.h.

int coil::DynamicLib::m_error [private]

Definition at line 287 of file posix/coil/DynamicLib.h.

void* coil::DynamicLib::m_handle [private]

Definition at line 286 of file posix/coil/DynamicLib.h.

HINSTANCE coil::DynamicLib::m_handle [private]

Definition at line 301 of file win32/coil/DynamicLib.h.

int coil::DynamicLib::m_mode [private]

Definition at line 284 of file posix/coil/DynamicLib.h.

std::string coil::DynamicLib::m_name [private]

Definition at line 283 of file posix/coil/DynamicLib.h.

---

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

• posix/coil/DynamicLib.h
• win32/coil/DynamicLib.h
• posix/coil/DynamicLib.cpp
• win32/coil/DynamicLib.cpp