EasyUSB::Errors::Error Class Reference

Base error class, all EasyUSB errors are derived from this class. More...

Inheritance diagram for EasyUSB::Errors::Error:

Public Member Functions
	Error (const Error &orig) throw ()
	Copy constructor.
	Error (wstring Function, wstring Description, unsigned int WinError=0) throw ()
	Constructor with initialisation.
	Error () throw ()
	Constructor.
wstring	GetDescription () throw ()
	Gets the description of the error.
wstring	GetFunction () throw ()
	Gets the function in which the error occured.
virtual wstring	GetText () throw ()
	Gets a verbose description of the error.
unsigned int	GetWinError () throw ()
	Gets the windows error code.
	~Error () throw ()
	Destructor.
Protected Attributes
wstring	m_Description
	The error description.
wstring	m_Function
	The function in which the error occured.
unsigned int	m_WinError
	The windows error code, if available.

---

Detailed Description

Base error class, all EasyUSB errors are derived from this class.

---

Constructor & Destructor Documentation

EasyUSB::Errors::Error::Error

(

)

throw ()

Constructor.

EasyUSB::Errors::Error::Error	(	wstring	Function,
		wstring	Description,
		unsigned int	WinError = 0
	)			throw ()

Constructor with initialisation.

Parameters:

	Function	The function in which the error occured.
	Description	A description of the error.
	WinError	A windows error code if available.

EasyUSB::Errors::Error::Error

(

const Error &

orig

)

throw ()

Copy constructor.

EasyUSB::Errors::Error::~Error

(

)

throw ()

Destructor.

---

Member Function Documentation

wstring EasyUSB::Errors::Error::GetDescription

(

)

throw ()

Gets the description of the error.

Returns:

Error description.

wstring EasyUSB::Errors::Error::GetFunction

(

)

throw ()

Gets the function in which the error occured.

Returns:

Function name.

virtual wstring EasyUSB::Errors::Error::GetText

(

)

throw () [virtual]

Gets a verbose description of the error.

Returns:

The error text.

Reimplemented in EasyUSB::Errors::InvalidParameter, EasyUSB::Errors::ResourceError, EasyUSB::Errors::DeviceLost, and EasyUSB::Errors::IOError.

unsigned int EasyUSB::Errors::Error::GetWinError

(

)

throw ()

Gets the windows error code.

Returns:

Windows error code.

---

Field Documentation

wstring EasyUSB::Errors::Error::m_Description [protected]

The error description.

wstring EasyUSB::Errors::Error::m_Function [protected]

The function in which the error occured.

unsigned int EasyUSB::Errors::Error::m_WinError [protected]

The windows error code, if available.